package ozstd

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Ozstd.Decompressor`Source

Zstandard decompression module.

The module offers both one-shot and streaming APIs for decompressing data.

Sourcemodule Context : sig ... end

A reusable decompression context.

val decompress_bigstring : 
  ?context:Context.t ->
  ?dictionary:Dictionary.t ->
  Bstr.t ->
  Bstr.t

decompress_bigstring ?context ?dictionary bigstring

Decompresses bigstring and returns the uncompressed data as a new bigstring.

val decompress_string : 
  ?context:Context.t ->
  ?dictionary:Bstr.t ->
  string ->
  string

decompress_string ?context ?dictionary string

Decompresses string and returns the uncompressed data as a new string.

val decompress_channel : 
  ?dictionary:Dictionary.t ->
  ?size_limit:int ->
  in_channel ->
  out_channel ->
  unit

decompress_channel ic oc

Decompresses data from ic channel to oc channel.

val decompress_bigstring_into : 
  ?context:Context.t ->
  ?dictionary:Dictionary.t ->
  Bstr.t ->
  Bstr.t ->
  int

compress_bigstring_into ?context ?dictionary src dst

Decompresses src bigstring into dst bigstring buffer.

val decompress_string_into_bytes : 
  ?context:Context.t ->
  ?dictionary:Dictionary.t ->
  string ->
  bytes ->
  int

compress_bigstring_into ?context ?dictionary src dst

Decompresses src string into dst bytes buffer.

Sourcemodule Stream : sig ... end

The decompression stream module for incremental decompression.

Sourcemodule State : sig ... end

A decompression stream state for feeding bytes during streaming decompression.