package eio

You can search for identifiers within the package.

in-package search v0.2.0

package eio

eio
- Eio
  - Buf_read
    
    BE
    
    LE
    
    Syntax
  - Buf_write
    
    BE
    
    LE
  - Cancel
  - Condition
  - Debug
  - Domain_manager
    
    t
  - Exn
    
    Backend
  - Fiber
    
    List
  - File
    
    Stat
    
    Unix_perm
    
    ro
    
    rw
  - Flow
    
    close
    
    sink
    
    source
    
    two_way
  - Fs
    
    dir
    
    dir_with_close
  - Generic
    
    t
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Sockaddr
    
    datagram_socket
    
    listening_socket
    
    socket
    
    stream_socket
    
    t
  - Path
  - Private
    
    Broadcast
    
    Cells
    
    CELL
    
    Make
    
    Cell
    
    Ctf
    
    Control
    
    Debug
    
    Dla
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Waiters
  - Process
    
    mgr
    
    t
  - Promise
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Mono
    
    t
    
    Timeout
    
    clock
    
    clock_base
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
    
    Mono
    
    S
  - Flow
  - Handler
  - Net
eio.unix
- Eio_unix
  - Ctf
  - Fd
  - Net
    
    Ipaddr
    
    datagram_socket
    
    stream_socket
    
    t
  - Private
    
    Rcfd
  - Process
    
    mgr
  - Resource
  - Stdenv
eio.utils
- Eio_utils
  - Lf_queue
  - Suspended
  - Zzz
    
    Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

Mock Eio.Flow sources and sinks.

type copy_method = [

| `Read_into
(*
Use the source's read_into method (the default).
*)
| `Read_source_buffer
(*
Use the Eio.Flow.Read_source_buffer optimisation.
*)

]

type t =
  < Eio.Flow.two_way
  ; Eio.Flow.close
  ; on_read : string Handler.t
  ; on_copy_bytes : int Handler.t
  ; set_copy_method : copy_method -> unit
  ; attach_to_switch : Eio.Switch.t -> unit >

val make : ?pp:string Fmt.t -> string -> t

make label is a mock Eio flow. It can be used as a source, sink, or two-way flow.

parameter pp
Printer to use to display the data.

val on_read : t -> string Handler.actions -> unit

on_read t actions configures the values to return from the mock's read function.

val on_copy_bytes : t -> int Handler.actions -> unit

on_copy_bytes t actions configures the number of bytes to copy in each iteration.

val set_copy_method : t -> copy_method -> unit

set_copy_method t m configures t to use the given method to read from a source during a copy operation.