package mirage-flow

  1. Overview
  2. Docs
Flow implementations and combinators for MirageOS

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. T
    Thomas Gazagnaire
  2. D
    Dave Scott

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

mirage-flow-v3.0.0.tbz
sha256=d70bda6c85ec2747bed88bc4d95f269d2810503b92913f0807be5291696138fc
sha512=2aeb397799621bc0ea2485b68058949c99b3da8d454939d594a9b2d39ef47aa2c16489f06adfa2dea3b34fd15e60a23abc6b8e214dfbc8b7da2e958de7c36b57

doc/mirage-flow/Mirage_flow/index.html

Module Mirage_flowSource

This module defines the flow signature for MirageOS.

Release v3.0.0

Sourcetype write_error = [
  1. | `Closed
]

The type for generic write errors on flows.

Sourceval pp_write_error : write_error Fmt.t

pp_write_error is the pretty-printer for write errors.

Sourcetype 'a or_eof = [
  1. | `Data of 'a
  2. | `Eof
]

The type for read results on flows.

Sourceval pp_or_eof : 'a Fmt.t -> 'a or_eof Fmt.t

pp_or_eof is the pretty-printer for or_eof values.

Sourcemodule type S = sig ... end

Abstract flow signature.

Copy stats

Sourcetype stats = {
  1. read_bytes : int64;
  2. read_ops : int64;
  3. write_bytes : int64;
  4. write_ops : int64;
  5. duration : int64;
}

The type for I/O statistics from a copy operation.

Sourceval pp_stats : stats Fmt.t

pp_stats is the pretty-printer for flow stats.