package mirage-flow-lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

String flows
Cstruct buffers flows

mirage-flow-lwt
- Mirage_flow_lwt
  - Copy
    
    Clock
  - F
  - Proxy
    
    Clock

Legend:
Library
Module
Module type
Parameter
Class
Class type

In-memory, function-based flows.

include S

type 'a io = 'a Lwt.t

type error

val pp_error : error Fmt.t

type write_error = private [>

| Mirage_flow.write_error

]

val pp_write_error : write_error Fmt.t

type buffer = Cstruct.t

type flow

val read : flow -> (buffer Mirage_flow.or_eof, error) Stdlib.result io

val write : flow -> buffer -> (unit, write_error) Stdlib.result io

val writev : flow -> buffer list -> (unit, write_error) Stdlib.result io

val close : flow -> unit io

type refill = Cstruct.t -> int -> int -> int Lwt.t

The type for refill functions.

val make : 
  ?close:(unit -> unit Lwt.t) ->
  ?input:refill ->
  ?output:refill ->
  unit ->
  flow

make ~close ~input ~output () is a flow using input to refill its internal input buffer when needed and output to refill its external output buffer. It is using close to eventually clean-up other resources on close.

String flows

val input_string : string -> refill

input_string buf is the refill function reading its inputs from the string buf.

val output_bytes : bytes -> refill

output_bytes buf is the refill function writing its outputs in the buffer buf.

val string : ?input:string -> ?output:bytes -> unit -> flow

The flow built using input_string and output_bytes.

val input_strings : string list -> refill

input_strings bufs is the refill function reading its inputs from the list of buffers bufs. Empty strings are ignored.

val output_bytess : bytes list -> refill

output_bytess buf is the refill function writing its outputs in the list of buffers buf. Empty strings are ignored.

val strings : ?input:string list -> ?output:bytes list -> unit -> flow

The flow built using input_strings and output_bytess.

Cstruct buffers flows

val input_cstruct : Cstruct.t -> refill

Same as input_string but for Cstruct.t buffers.

val output_cstruct : Cstruct.t -> refill

Same as output_string buf for Cstruct.t buffers.

val cstruct : ?input:Cstruct.t -> ?output:Cstruct.t -> unit -> flow

Same as string but for Cstruct.t buffers.

val input_cstructs : Cstruct.t list -> refill

Same as input_strings but for Cstruct.t buffers.

val output_cstructs : Cstruct.t list -> refill

Same as output_strings but for Cstruct.t buffers.

val cstructs : ?input:Cstruct.t list -> ?output:Cstruct.t list -> unit -> flow

Same as strings but for Cstruct.t buffers.