RZstd (RZstd v1.1.0-rc.2) View Source

RZstd API.

Link to this section Summary

Link to this section Types

Specs

compression_error() ::
  :binary_decode_failed
  | :integer_decode_failed
  | :compression_failed
  | :binary_alloc_failed
  | :binary_write_failed
Link to this type

compression_with_compressor_error()

View Source

Specs

compression_with_compressor_error() ::
  compression_error() | :compressor_decode_failed

Specs

decompression_error() ::
  :binary_decode_failed
  | :decompression_failed
  | :binary_alloc_failed
  | :binary_write_failed
Link to this type

decompression_with_decompressor_error()

View Source

Specs

decompression_with_decompressor_error() ::
  decompression_error() | :decompressor_decode_failed

Link to this section Functions

Specs

compress(binary(), integer()) :: {:ok, binary()} | {:error, compression_error()}
Link to this function

compress(data, level, compressor)

View Source

Specs

compress(binary(), integer(), RZstd.Compressor.t()) ::
  {:ok, binary()} | {:error, compression_with_compressor_error()}

Unsafe proxy definition for compress/2.

Link to this function

compress!(arg0, arg1, arg2)

View Source

Unsafe proxy definition for compress/3.

Link to this function

compress_dirty(data, level)

View Source

Specs

compress_dirty(binary(), integer()) ::
  {:ok, binary()} | {:error, compression_error()}
Link to this function

compress_dirty(data, level, compressor)

View Source

Specs

compress_dirty(binary(), integer(), RZstd.Compressor.t()) ::
  {:ok, binary()} | {:error, compression_with_compressor_error()}
Link to this function

compress_dirty!(arg0, arg1)

View Source

Unsafe proxy definition for compress_dirty/2.

Link to this function

compress_dirty!(arg0, arg1, arg2)

View Source

Unsafe proxy definition for compress_dirty/3.

Specs

decompress(binary()) :: {:ok, binary()} | {:error, compression_error()}
Link to this function

decompress(data, decompressor)

View Source

Specs

decompress(binary(), RZstd.Decompressor.t()) ::
  {:ok, binary()} | {:error, decompression_with_decompressor_error()}

Unsafe proxy definition for decompress/1.

Unsafe proxy definition for decompress/2.

Specs

decompress_dirty(binary()) :: {:ok, binary()} | {:error, decompression_error()}
Link to this function

decompress_dirty(data, decompressor)

View Source

Specs

decompress_dirty(binary(), RZstd.Decompressor.t()) ::
  {:ok, binary()} | {:error, decompression_with_decompressor_error()}

Unsafe proxy definition for decompress_dirty/1.

Link to this function

decompress_dirty!(arg0, arg1)

View Source

Unsafe proxy definition for decompress_dirty/2.