package bytesrw

  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 (2)

Authors

  1. T
    The bytesrw programmers

Maintainers

  1. Daniel Bünzli

Sources

bytesrw-0.2.0.tbz
sha512=e3f07dbd808e152cd4b2ea5c2fa3863d4b72f7f97cfa3cd7493a3725c84f39d882042388ee47c9d6acfd30a650c21db429c8264db3d7466cad6e580308b5a2d2

doc/bytesrw.zlib/Bytesrw_zlib/Zlib/index.html

Module Bytesrw_zlib.ZlibSource

zlib streams.

Decompress

Sourceval decompress_reads : ?leftover:bool -> unit -> Bytesrw.Bytes.Reader.filter

decompress_reads () r filters the reads of r by decompressing a zlib stream. If leftover is:

  • false (default), the reader errors if there is leftover data after the end of the zlib stream.
  • true the reader decompresses one zlib stream. Once the reader returns Bytesrw.Bytes.Slice.eod, r is positioned exactly after the end of the zlib stream and can be read again to perform other non-filtered reads.
Sourceval decompress_writes : unit -> Bytesrw.Bytes.Writer.filter

decompress_writes () w ~eod filters writes on w by decompressing a zlib stream until Bytesrw.Bytes.Slice.eod is written, if leftover data remains an error is raised. If eod is false the last Bytes.Slice.eod is not written on w and at this point w can be used again to perform othe non-filtered writes.

Compress

Sourceval compress_reads : ?level:level -> unit -> Bytesrw.Bytes.Reader.filter

compress_reads ~level () r filters the reads of r by compressing them to a zlib stream at level level (defaults to default_compression).

Sourceval compress_writes : ?level:level -> unit -> Bytesrw.Bytes.Writer.filter

compress_writes ~level () w ~eod filters writes on w by compressing them to a zlib stream at level level (defaults to default_compression) until Bytesrw.Bytes.Slice.eod is written. If eod is false, the latter is not written on w and at that point w can be used again to perform non-filtered writes.