The ZLibEncoder encoder is used by ZLibCodec and GZipCodec to compress data.
Properties
- List<int> dictionary
-
read-onlyInitial compression dictionary.
- bool gzip
-
read-onlyWhen true,
GZip
frames will be added to the compressed data. - int level
-
read-onlyThe compression-level can be set in the range of
-1..9
, with6
being the default compression level. Levels above6
will have higher compression rates at the cost of more CPU and memory usage. Levels below6
will use less CPU and memory at the cost of lower compression rates. - int memLevel
-
read-onlySpecifies how much memory should be allocated for the internal compression state.
1
uses minimum memory but is slow and reduces compression ratio;9
uses maximum memory for optimal speed. The default value is8
. - bool raw
-
read-onlyWhen true, deflate generates raw data with no zlib header or trailer, and will not compute an adler32 check value
- int strategy
-
read-onlyTunes the compression algorithm. Use the value ZLibOption.STRATEGY_DEFAULT for normal data, ZLibOption.STRATEGY_FILTERED for data produced by a filter (or predictor), [ZLibOption.STRATEGY_HUFFMAN_ONLY] to force Huffman encoding only (no string match), or ZLibOption.STRATEGY_RLE to limit match distances to one (run-length encoding).
- int windowBits
-
read-onlyBase two logarithm of the window size (the size of the history buffer). It should be in the range
8..15
. Larger values result in better compression at the expense of memory usage. The default value is15
Constructors
Methods
-
bind(
Stream stream) → Stream -
inheritedTransform the incoming
stream
's events. -
convert(
List<int> bytes) → List<int> - Convert a list of bytes using the options given to the ZLibEncoder constructor.
-
fuse(
Converter<List<int>> other) → Converter<List<int>> -
inheritedFuses
this
withother
. -
startChunkedConversion(
Sink<List<int>> sink) → ByteConversionSink -
Start a chunked conversion using the options given to the ZLibEncoder
constructor. While it accepts any Sink taking
List<int>
's, the optimal sink to be passed assink
is a ByteConversionSink.