package ozstd

  1. Overview
  2. Docs

Module Decompressor.StreamSource

The decompression stream module for incremental decompression.

Sourcetype t
Sourceexception Already_closed

Raised when trying to decompress a closed stream.

Sourceval create : ?dictionary:Dictionary.t -> ?size_limit:int -> unit -> t

create ?dictionary ?size_limit ()

Creates a new decompression stream.

Sourceval close : t -> unit

finish ()

Close a decompression stream.

Decompression

Sourceval decompress : in_slice:Slice_bstr.t -> out_slice:Slice_bstr.t -> t -> remaining:int * consumed:int * decompressed:int

decompress ~in_slice ~out_slice stream

Decompresses bytes from in_slice into out_slice buffer.

  • returns

    A labeled triple (~remaining, ~consumed, ~decompressed) where:

    • remaining is the number of bytes remaining in the source;
    • consumed is the number of bytes consumed from in_slice;
    • decompressed is the number of decompressed bytes written to out_slice.

Buffers sizes

Sourceval in_size : unit -> int

in_size () returns the recommended size for the input decompression buffer.

Sourceval out_size : unit -> int

out_size () returns the recommended size for the output decompression buffer.