package eio

  1. Overview
  2. Docs
Effect-based direct-style IO API for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (19)

Authors

  1. A
    Anil Madhavapeddy
  2. T
    Thomas Leonard

Maintainers

  1. A
    anil@recoil.org

Sources

eio-0.11.tbz
sha256=0c33742074562631677886f4fe4a02f9672cec94297ff85c2ed854db5baa71aa
sha512=590843cb5fb3906fd5ab9911d29206172d164a53c48e635871a23c95d4cdce8ae0999480471187fdddee8c9c523148911ca140feabde6a826c317671a3b33090

doc/eio.mock/Eio_mock/Flow/index.html

Module Eio_mock.FlowSource

Mock Eio.Flow sources and sinks.

Sourcetype copy_method = [
  1. | `Read_into
    (*

    Use the source's read_into method (the default).

    *)
  2. | `Read_source_buffer
    (*

    Use the Eio.Flow.Read_source_buffer optimisation.

    *)
]
Sourcetype 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 >
Sourceval 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.

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

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

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

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

Sourceval 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.