Struct lzzzz::lz4f::PreferencesBuilder

pub struct PreferencesBuilder { /* private fields */ }

Builds a custom Preferences.

Example

use lzzzz::lz4f::{BlockSize, PreferencesBuilder, CLEVEL_MAX};

let pref = PreferencesBuilder::new()
    .block_size(BlockSize::Max1MB)
    .compression_level(CLEVEL_MAX)
    .build();

Implementations

impl PreferencesBuilder

pub fn new() -> Self

Creates a new PreferencesBuilder.

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

Sets the block size.

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

Sets the block mode.

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

Sets the content checksum.

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

Sets the content size.

A value greater than 0 enables the content size field in the frame header and automatically replaced with an actual content size.

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

Sets the dictionary id.

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

Sets the block checksum.

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

Sets the compression level.

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

Sets the decompression speed mode flag.

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

Sets the auto flush mode flag.

pub const fn build(&self) -> Preferences

Builds a Preferences with this configuration.

Trait Implementations

impl Clone for PreferencesBuilder

fn clone(&self) -> PreferencesBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreferencesBuilder

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

Formats the value using the given formatter.

impl Default for PreferencesBuilder

fn default() -> PreferencesBuilder

Returns the “default value” for a type.

impl From<Preferences> for PreferencesBuilder

fn from(prefs: Preferences) -> Self

Converts to this type from the input type.

impl Hash for PreferencesBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PreferencesBuilder

fn eq(&self, other: &PreferencesBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PreferencesBuilder

impl Eq for PreferencesBuilder

impl StructuralPartialEq for PreferencesBuilder