package bytesrw

All checked builds pass
  1. Overview
  2. Docs
Composable byte stream readers and writers for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (5)

Authors

  1. T
    The bytesrw programmers

Maintainers

  1. Daniel Bünzli

Sources

bytesrw-0.4.1.tbz
sha512=9d4d65ff080a107f2ed35c4f13ac77c20e4920e92dffe84c270f23169d7db130506a450aa83a6c6c621ce80b699191291fb8be227d1fb47fb5fd49ddc150b37e

Description

Bytesrw extends the OCaml Bytes module with composable, memory efficient, byte stream readers and writers compatible with effect based concurrency.

Except for byte slice life-times, these abstractions intentionally separate away resource management and the specifics of reading and writing bytes.

Bytesrw distributed under the ISC license. It has no dependencies.

Optional support for compressed, hashed and encrypted bytes depend, at your wish, on the C zlib, libzstd, blake3, libmd, xxhash and mbedtls libraries.

Homepage: https://erratique.ch/software/bytesrw/

Tags

bytes entropy streaming zstd zlib gzip deflate random csprng sha1 sha2 compression hashing utf xxhash blake3 psa tls websocket cryptography sha3 org:erratique

Added to opam-repository:

README

Bytesrw – Composable byte stream readers and writers for OCaml

Bytesrw extends the OCaml Bytes module with composable, memory efficient, byte stream readers and writers compatible with effect based concurrency.

Except for byte slice life-times, these abstractions intentionally separate away resource management and the specifics of reading and writing bytes.

Bytesrw distributed under the ISC license. It has no dependencies.

Optional support for compressed, hashed and encrypted bytes depend, at your wish, on the C zlib, libzstd, blake3, libmd, xxhash and mbedtls libraries.

Homepage: https://erratique.ch/software/bytesrw/

Installation

Bytesrw can be installed with opam

    opam install bytesrw

# Compression support
opam install bytesrw conf-zlib conf-zstd

# Hashing support
opam install bytesrw conf-libblake3 conf-libmd conf-xxhash

# Cryptography (and hashing) support 
opam install conf-mbedtsl

# certown tool 
opam install bytesrw conf-mbedtls b0 cmdliner

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation can be consulted online or via odig doc bytesrw.

Questions are welcome but better asked on the OCaml forum than on the issue tracker.

Examples

A few examples can be found in the test directory.

Acknowledgments

A grant from the OCaml Software Foundation helped to bring the first public release of bytesrw. Another one funded the cryptography support.

Dependencies (5)

  1. conf-pkg-config build
  2. topkg build & >= "1.1.1"
  3. ocamlbuild build
  4. ocamlfind build
  5. ocaml >= "4.14.0"

Dev Dependencies

None

Conflicts (3)

  1. b0 < "0.0.7"
  2. cmdliner < "2.0.0"
  3. conf-zstd < "1.3.8"

Build status

Results of building bytesrw with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.4.1 (this version) n/a good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure