decompress package:zstd

Decompress a single-frame payload of known size. Typically this will be a payload that was compressed with compress. Note: This function is not capable of decompressing a payload generated by the streaming or lazy compression APIs.

Decompress a buffer. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error description if it fails.

Decompress a buffer. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error code if it fails (which can be tested using isError).

Decompress a payload. The input will be consumed lazily, and the decompressed result generated lazily. Note: if any error occurs, decompression will fail part-way through with a call to error.

Begin a streaming decompression operation. The initial result will be either an Error or a Consume.

The result of a decompression operation.

The payload was successfully decompressed.

Decompress a single-frame payload of known size, using a prebuilt dictionary. Typically this will be a payload that was compressed with compressUsingDict. Note: This function is not capable of decompressing a payload generated by the streaming or lazy compression APIs.

Return the decompressed size of a compressed payload, as stored in the payload's header. The returned value will be Nothing if it is either not known (probably because the payload was compressed using a streaming API), empty, or too large to fit in an Int. Note: this value should not be trusted, as it can be controlled by an attacker.

Decompress a buffer. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error description if it fails.

Consume part or all of an input.

Decompress bytes from source buffer into destination buffer, using a pre-digested dictionary. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error description if it fails.

Decompress a buffer. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error description if it fails.

Decompress a single-frame payload of known size. Typically this will be a payload that was compressed with compress. Note: This function is not capable of decompressing a payload generated by the streaming or lazy compression APIs.

Decompress a single-frame payload of known size, using a pre-built, pre-digested dictionary. Typically this will be a payload that was compressed with compressUsingCDict. Note: This function is not capable of decompressing a payload generated by the streaming or lazy compression APIs.

Decompress a buffer. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error code if it fails (which can be tested using isError).

Consume part or all of an input.

Decompress a buffer, using a pre-built, pre-digested dictionary. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error code if it fails (which can be tested using isError).

Decompress a buffer, using a prebuilt dictionary. The destination buffer must be already allocated. Returns the number of bytes written into destination buffer, or an error code if it fails (which can be tested using isError).

Returns the decompressed size of a compressed payload if known. To discover precisely why a result is not known, follow up with getFrameParams.

Returns the decompressed size of a compressed payload if known, 0 otherwise. To discover precisely why a result is 0, follow up with getFrameParams.