Module: Zstd

Includes:

Constants

Defined in:

lib/extzstd.rb,
lib/extzstd/version.rb,
ext/extzstd.c

Overview

This is ruby bindings for zstd <github.com/Cyan4973/zstd> the compression library.

Defined Under Namespace

Modules: Constants, ContextLess, Dictionary, Exceptions, Internals Classes: Decoder, Encoder, Error, Parameters

Constant Summary

Compressor =

Encoder

StreamEncoder =

Encoder

Uncompressor =

Decoder

Decompressor =

Decoder

StreamDecoder =

Decoder

VERSION =

String($1)

LIBRARY_VERSION =

libver

Constants included from Constants

Constants::BTLAZY2, Constants::BTOPT, Constants::BTULTRA, Constants::BTULTRA2, Constants::CHAINLOG_MAX, Constants::CHAINLOG_MIN, Constants::DFAST, Constants::FAST, Constants::GREEDY, Constants::HASHLOG_MAX, Constants::HASHLOG_MIN, Constants::LAZY, Constants::LAZY2, Constants::MAX_COMPRESSION_LEVEL, Constants::MINMATCH_MAX, Constants::MINMATCH_MIN, Constants::SEARCHLOG_MAX, Constants::SEARCHLOG_MIN, Constants::STRATEGY_MAX, Constants::STRATEGY_MIN, Constants::TARGETLENGTH_MAX, Constants::TARGETLENGTH_MIN, Constants::WINDOWLOG_MAX, Constants::WINDOWLOG_MIN, Constants::ZSTD_BTLAZY2, Constants::ZSTD_BTOPT, Constants::ZSTD_BTULTRA, Constants::ZSTD_BTULTRA2, Constants::ZSTD_CHAINLOG_MAX, Constants::ZSTD_CHAINLOG_MIN, Constants::ZSTD_DFAST, Constants::ZSTD_FAST, Constants::ZSTD_GREEDY, Constants::ZSTD_HASHLOG_MAX, Constants::ZSTD_HASHLOG_MIN, Constants::ZSTD_LAZY, Constants::ZSTD_LAZY2, Constants::ZSTD_MAX_COMPRESSION_LEVEL, Constants::ZSTD_MINMATCH_MAX, Constants::ZSTD_MINMATCH_MIN, Constants::ZSTD_SEARCHLOG_MAX, Constants::ZSTD_SEARCHLOG_MIN, Constants::ZSTD_STRATEGY_MAX, Constants::ZSTD_STRATEGY_MIN, Constants::ZSTD_TARGETLENGTH_MAX, Constants::ZSTD_TARGETLENGTH_MIN, Constants::ZSTD_WINDOWLOG_MAX, Constants::ZSTD_WINDOWLOG_MIN

Class Method Summary

• .decode(src, *args, **opts, &block) ⇒ Object (also: decompress, uncompress)

  call-seq: decode(zstd_string, maxsize = nil, dict: nil) -> string decode(zstd_stream, dict: nil) -> zstd decoder decode(zstd_stream, dict: nil) { |decoder| … } -> yield returned value.

• .encode(src, *args, **opts, &block) ⇒ Object (also: compress)

  call-seq: encode(src_string, level = nil, opts = {}) -> zstd string encode(src_string, encode_params, opts = {}) -> zstd string encode(outport, level = nil, opts = {}) -> zstd encoder encode(outport, level = nil, opts = {}) { |encoder| … } -> yield returned value encode(outport, encode_params, opts = {}) -> zstd encoder encode(outport, encode_params, opts = {}) { |encoder| … } -> yield returned value.

Class Method Details

.decode(src, *args, **opts, &block) ⇒ Object Also known as: decompress, uncompress

call-seq:

decode(zstd_string, maxsize = nil, dict: nil) -> string
decode(zstd_stream, dict: nil) -> zstd decoder
decode(zstd_stream, dict: nil) { |decoder| ... } -> yield returned value

# File 'lib/extzstd.rb', line 71

def self.decode(src, *args, **opts, &block)
  src.unzstd(*args, **opts, &block)
end

.encode(src, *args, **opts, &block) ⇒ Object Also known as: compress

call-seq:

encode(src_string, level = nil, opts = {}) -> zstd string
encode(src_string, encode_params, opts = {}) -> zstd string
encode(outport, level = nil, opts = {}) -> zstd encoder
encode(outport, level = nil, opts = {}) { |encoder| ... } -> yield returned value
encode(outport, encode_params, opts = {}) -> zstd encoder
encode(outport, encode_params, opts = {}) { |encoder| ... } -> yield returned value

src_string (string)

outport (io liked object)

level = nil (integer or nil)

encode_params (instance of Zstd::Parameters)

opts dict: nil (string or nil)

# File 'lib/extzstd.rb', line 61

def self.encode(src, *args, **opts, &block)
  src.to_zstd(*args, **opts, &block)
end