package mirage-flow-lwt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

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

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Clock : Mirage_clock.MCLOCK

module A : S

module B : 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 : 
  Clock.t ->
  src:A.flow ->
  dst:B.flow ->
  (Mirage_flow.stats, error) Stdlib.result Lwt.t

copy clock 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.