package eio

You can search for identifiers within the package.

in-package search v0.2.0

Effect-based direct-style IO API for OCaml

Install

Dune Dependency

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

Authors

Maintainers

A

anil@recoil.org

Sources

eio-0.8.1.tbz

sha256=c4222f9b081465486a1c1a8dde6aa00178936d7c7b3a8565e0883a421e0e3547

sha512=d63d8b9500b492be93df4f29159aa6955588ca1e35e6a5817856e32ee4fec3395604dc7b64fc5a973ee8bd436bd65831e7b08fca9bf909f41afec4a65c4443b8

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

Module `Eio_mock.Flow`Source

Mock Eio.Flow sources and sinks.

Sourcetype copy_method = [

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

]

Source

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 >

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.