Struct EncoderBuilder 

pub struct EncoderBuilder { /* private fields */ }

Builder for Encoder that collects LZ4 frame preferences before constructing the streaming encoder.

Preferences correspond to the fields of upstream LZ4F_preferences_t (see lz4frame.h). Defaults match the lz4-rs crate, not the upstream lz4 CLI; for CLI-compatible defaults see src/bin/lz4.rs.

Implementations

impl EncoderBuilder

pub fn new() -> Self

Returns a builder pre-populated with the same defaults used by the lz4-rs crate (linked blocks, content + block checksums enabled, fast-mode compression).

pub fn block_size(&mut self, block_size: BlockSize) -> &mut Self

Selects the maximum block size (64 KiB, 256 KiB, 1 MiB, or 4 MiB). Larger blocks generally improve compression ratio at the cost of memory.

pub fn block_mode(&mut self, block_mode: BlockMode) -> &mut Self

Sets whether blocks may reference data from previous blocks (BlockMode::Linked) or must each compress independently (BlockMode::Independent).

pub fn block_checksum(&mut self, block_checksum: BlockChecksum) -> &mut Self

Enables or disables the per-block xxHash32 trailer that follows each compressed block.

pub fn checksum(&mut self, checksum: ContentChecksum) -> &mut Self

Enables or disables the xxHash32 checksum of the full decompressed content that is appended to the frame footer.

pub fn level(&mut self, level: u32) -> &mut Self

Sets the compression level. 0 selects fast mode; levels 3..=12 route through HC. Levels above 12 are clamped by the underlying implementation.

pub fn auto_flush(&mut self, auto_flush: bool) -> &mut Self

When true, every Encoder::write call is flushed to the inner writer instead of being buffered, reducing internal memory usage at some cost in compression ratio for small writes.

pub fn favor_dec_speed(&mut self, favor_dec_speed: bool) -> &mut Self

Favor decompression speed over compression ratio. Requires compression level >=10.

pub fn content_size(&mut self, content_size: u64) -> &mut Self

Records the total uncompressed content size in the frame header. Use 0 (the default) when the size is unknown ahead of time.

pub fn build<W: Write>(&self, w: W) -> Result<Encoder<W>>

Consumes the builder, allocates an LZ4 frame compression context, writes the frame header into w, and returns the resulting streaming encoder.

Trait Implementations

impl Clone for EncoderBuilder

fn clone(&self) -> EncoderBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncoderBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncoderBuilder

fn default() -> Self

Returns the “default value” for a type.