Struct libflate::gzip::EncodeOptions

pub struct EncodeOptions<E> where
    E: Lz77Encode,  { /* fields omitted */ }

Options for a GZIP encoder.

Methods

impl EncodeOptions<DefaultLz77Encoder>

pub fn new() -> Self

Makes a default instance.

Examples

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

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

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::gzip::{Encoder, EncodeOptions};

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

pub fn no_compression(self) -> Self

Disables LZ77 compression.

Example

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

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

pub fn header(self, header: Header) -> Self

Sets the GZIP header which will be written to the output stream.

Example

use libflate::gzip::{Encoder, EncodeOptions, HeaderBuilder};

let header = HeaderBuilder::new().text().modification_time(100).finish();
let options = EncodeOptions::new().header(header);
let encoder = Encoder::with_options(Vec::new(), options).unwrap();

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

Specifies the hint of the size of a DEFLATE block.

The default value is deflate::DEFAULT_BLOCK_SIZE.

Example

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

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

pub fn fixed_huffman_codes(self) -> Self

Specifies to compress with fixed huffman codes.

Example

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

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

Trait Implementations

impl Default for EncodeOptions<DefaultLz77Encoder>

fn default() -> Self

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.