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
  - CONCRETE
  - Concrete
    
    S
  - Copy
    
    A
    
    B
  - F
  - Proxy
    
    A
    
    B
  - SHUTDOWNABLE

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Clock : Mirage_clock.MCLOCK

module A : Mirage_flow.S

module B : Mirage_flow.S

Signature

type error = [

| `A of A.error
| `B of B.write_error

]

The type for copy errors.

val pp_error : error Fmt.t

pp_error pretty-prints errors.

val copy : 
  src:A.flow ->
  dst:B.flow ->
  (Mirage_flow.stats, error) Stdlib.result Lwt.t

copy source destination copies data from source to destination using the clock to compute a transfer rate. On successful completion, some statistics are returned. On failure we return a printable error.