package mirage-flow-unix

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

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-flow-5.0.0.tbz
sha256=37ca79cae0ed9b270b87712edcb397a5dec4ab39357b28107e00daa6c8553323
sha512=3cf9ebd09ce6e29f9f99a00bf47d2962ccd0e6627b0cdb407538c491480102211bde863d342624cdd4bdb2e1b198b8bf5b2109f881e8113210468ad5b5aa8632

Description

This repo contains generic operations over Mirage FLOW implementations.

Please consult the API documentation.

Tags

org:mirage

Published: 06 Feb 2025

README

mirag-flow -- Flow implementations and combinators for MirageOS

This repo contains generic operations over Mirage FLOW implementations.

Please consult the API documentation.

Example usage

In a top-level like utop:

# #require "mirage-flow";;
# #require "mirage-clock-unix";;
# #require "lwt.syntax";;

# let a = Mirage_flow.Fun.(make ~input:(input_string "hellooooo") ());;
val a : Mirage_flow.Fun.flow = <abstr>

# let buffer = String.make 20 ' ';;
val buffer : bytes = "                    "
# let b = Mirage_flow.Fun.(make ~output:(output_string buffer) ());;
val b : Mirage_flow.Fun.flow = <abstr>

# lwt results = Mirage_flow.copy (module Clock) (module Mirage_flow.Fun) a (module Mirage_flow.Fun) b ();;
val results : [ `Error of [ `Msg of bytes ] | `Ok of Mirage_flow.CopyStats.t ] =  `Ok {Mirage_flow.CopyStats.read_bytes = 9L; read_ops = 1L; write_bytes = 9L; write_ops = 1L; duration = 6.9141387939453125e-06}
# buffer;;
- : bytes = "hellooooo           "

Dependencies (7)

  1. cstruct >= "6.0.0"
  2. lwt >= "4.0.0"
  3. mirage-flow = version
  4. logs
  5. fmt >= "0.8.7"
  6. dune >= "1.0"
  7. ocaml >= "4.08.0"

Dev Dependencies (2)

  1. mirage-flow-combinators with-test & = version
  2. alcotest with-test

Conflicts

None

OCaml

Innovation. Community. Security.