package zstandard

  1. Overview
  2. Docs
type t
val create : int -> t
val compress : t -> inbuf:Core_kernel.Bigstring.t -> inpos:int -> inlen:int -> outbuf:Core_kernel.Bigstring.t -> outpos:int -> outlen:int -> int * int
val flush : t -> outbuf:Core_kernel.Bigstring.t -> outpos:int -> outlen:int -> int * int

Attempts to flush the contents of the internal buffers of t. If the output size is too small, a single invocation of the function might not be sufficient to flush the buffer.

val endstream : t -> outbuf:Core_kernel.Bigstring.t -> outpos:int -> outlen:int -> int * int

Performs a flush and write an epilogue for the stream. The epilogue is required for decoders to consider the message complete.

val free : t -> unit

free t deallocate the underlying datastructure. Subsequent uses of t will cause exceptions.