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

sha256=675e67f343ccf37b965d15d1ee1c639d7a06431e8f08e95559133419f3488ee1

sha512=3d1bd0e5e0aa79d8858d83944d734a0efc325ed66a12a1506c3b36281db56c0216e6cb90a46e6021db1ea34cdd2567ebabe0bd687d9989495bb7cf6099e90ba7

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.