Struct libflate::deflate::EncodeOptions

pub struct EncodeOptions<E = DefaultLz77Encoder> {
    block_size: usize,
    dynamic_huffman: bool,
    lz77: Option<E>,
}

Options for a DEFLATE encoder.

Fields

block_size: usize

dynamic_huffman: bool

lz77: Option<E>

Implementations

impl EncodeOptions<DefaultLz77Encoder>

pub fn new() -> Self

Makes a default instance.

Examples

use libflate::deflate::{Encoder, EncodeOptions};

let options = EncodeOptions::new();
let encoder = Encoder::with_options(Vec::new(), options);

impl<E> EncodeOptions<E>where
    E: Lz77Encode,

pub fn with_lz77(lz77: E) -> Self

Specifies the LZ77 encoder used to compress input data.

Example

use libflate::lz77::DefaultLz77Encoder;
use libflate::deflate::{Encoder, EncodeOptions};

let options = EncodeOptions::with_lz77(DefaultLz77Encoder::new());
let encoder = Encoder::with_options(Vec::new(), options);

pub fn no_compression(self) -> Self

Disables LZ77 compression.

Example

use libflate::lz77::DefaultLz77Encoder;
use libflate::deflate::{Encoder, EncodeOptions};

let options = EncodeOptions::new().no_compression();
let encoder = Encoder::with_options(Vec::new(), options);

pub fn block_size(self, size: usize) -> Self

Specifies the hint of the size of a DEFLATE block.

The default value is DEFAULT_BLOCK_SIZE.

Example

use libflate::deflate::{Encoder, EncodeOptions};

let options = EncodeOptions::new().block_size(512 * 1024);
let encoder = Encoder::with_options(Vec::new(), options);

pub fn fixed_huffman_codes(self) -> Self

Specifies to compress with fixed huffman codes.

Example

use libflate::deflate::{Encoder, EncodeOptions};

let options = EncodeOptions::new().fixed_huffman_codes();
let encoder = Encoder::with_options(Vec::new(), options);

fn get_block_type(&self) -> BlockType

fn get_block_size(&self) -> usize

Trait Implementations

impl<E: Clone> Clone for EncodeOptions<E>

fn clone(&self) -> EncodeOptions<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug> Debug for EncodeOptions<E>

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

Formats the value using the given formatter.

impl Default for EncodeOptions<DefaultLz77Encoder>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Hash> Hash for EncodeOptions<E>

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<E: PartialEq> PartialEq<EncodeOptions<E>> for EncodeOptions<E>

fn eq(&self, other: &EncodeOptions<E>) -> 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<E: Eq> Eq for EncodeOptions<E>

impl<E> StructuralEq for EncodeOptions<E>

impl<E> StructuralPartialEq for EncodeOptions<E>