Up – Package index » Data-encoding: Type-safe serialization and deserialization of data structures. » Library data-encoding » Data_encoding » Binary_stream

Module `Data_encoding.Binary_stream`Source

Sourcetype t

The type for a stream, as used in the Binary.read_stream function.

You never need to initialise a stream: one is initialised for you when you use first Binary.read_stream and you may pass a stream around to further calls to Binary.read_stream.

Sourceval is_empty : t -> bool

is_empty s is true iff the stream is not currently holding any yet-to-be-decoded bytes. Consequently, reading on that stream will always return Await.