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
    
    Pi
    
    MGR
  - Executor_pool
  - Exn
    
    Backend
  - Fiber
    
    List
  - File
    
    Pi
    
    READ
    
    WRITE
    
    Stat
    
    Unix_perm
  - Flow
    
    Pi
    
    SHUTDOWN
    
    SINK
    
    SOURCE
    
    TWO_WAY
  - Fs
    
    Pi
    
    DIR
  - Lazy
  - Mutex
  - Net
    
    Ipaddr
    
    V4
    
    V6
    
    Pi
    
    DATAGRAM_SOCKET
    
    LISTENING_SOCKET
    
    NETWORK
    
    STREAM_SOCKET
    
    Sockaddr
  - Path
  - Pool
  - Private
    
    Broadcast
    
    Cells
    
    CELL
    
    Make
    
    Cell
    
    Debug
    
    Dla
    
    Effects
    
    Fiber_context
    
    Suspend
    
    Trace
  - Process
    
    Pi
    
    MGR
    
    PROCESS
  - Promise
  - Resource
  - Semaphore
  - Std
  - Stdenv
  - Stream
  - Switch
  - Time
    
    Mono
    
    Pi
    
    CLOCK
    
    Timeout
eio.mock
- Eio_mock
  - Action
  - Backend
  - Clock
    
    Mono
    
    S
  - Domain_manager
  - Flow
  - Handler
  - Net
eio.runtime_events
- Eio_runtime_events
eio.unix
- Eio_unix
  - Cap
  - Fd
  - Net
    
    Ipaddr
  - Pi
    
    DATAGRAM_SOCKET
    
    FLOW
    
    LISTENING_SOCKET
    
    STREAM_SOCKET
  - Private
    
    Rcfd
    
    Thread_pool
  - Process
    
    Make_mgr
    
    X
    
    Pi
    
    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 ty = [ `Generic | `Mock ] Eio.Net.stream_socket_ty

type t = ty Eio.Std.r

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.