package mirage-flow-combinators

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

mirage-flow-combinators
- Mirage_flow_combinators
  - Copy
    
    Clock
  - F
  - Proxy
    
    A
    
    B
    
    Clock
  - SHUTDOWNABLE

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Clock : Mirage_clock.MCLOCK

module A : SHUTDOWNABLE

module B : SHUTDOWNABLE

Signature

type error

The type for proxy errors.

val pp_error : error Fmt.t

pp_error pretty-prints errors.

val proxy : 
  A.flow ->
  B.flow ->
  (Mirage_flow.stats * Mirage_flow.stats, error) Stdlib.result Lwt.t

proxy a b proxies data between a and b until both sides close. If either direction encounters an error then so will proxy. If both directions succeed, then return I/O statistics.