Struct libflate::gzip::Encoder[][src]

pub struct Encoder<W, E = DefaultLz77Encoder> {
    header: Header,
    crc32: Crc32,
    input_size: u32,
    writer: Encoder<W, E>,
}
Expand description

GZIP encoder.

Fields

header: Headercrc32: Crc32input_size: u32writer: Encoder<W, E>

Implementations

Makes a new encoder instance.

Encoded GZIP stream is written to inner.

Examples
use std::io::Write;
use libflate::gzip::Encoder;

let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(b"Hello World!").unwrap();
encoder.finish().into_result().unwrap();

Makes a new encoder instance with specified options.

Encoded GZIP stream is written to inner.

Examples
use std::io::Write;
use libflate::gzip::{Encoder, EncodeOptions, HeaderBuilder};

let header = HeaderBuilder::new().modification_time(123).finish();
let options = EncodeOptions::new().no_compression().header(header);
let mut encoder = Encoder::with_options(Vec::new(), options).unwrap();
encoder.write_all(b"Hello World!").unwrap();

assert_eq!(encoder.finish().into_result().unwrap(),
           &[31, 139, 8, 0, 123, 0, 0, 0, 0, 3, 1, 12, 0, 243, 255, 72, 101, 108, 108,
             111, 32, 87, 111, 114, 108, 100, 33, 163, 28, 41, 28, 12, 0, 0, 0][..]);

Returns the header of the GZIP stream.

Examples
use libflate::gzip::{Encoder, Os};

let encoder = Encoder::new(Vec::new()).unwrap();
assert_eq!(encoder.header().os(), Os::Unix);

Writes the GZIP trailer and returns the inner stream.

Examples
use std::io::Write;
use libflate::gzip::Encoder;

let mut encoder = Encoder::new(Vec::new()).unwrap();
encoder.write_all(b"Hello World!").unwrap();

assert!(encoder.finish().as_result().is_ok())
Note

If you are not concerned the result of this encoding, it may be convenient to use AutoFinishUnchecked instead of the explicit invocation of this method.

use std::io;
use libflate::finish::AutoFinishUnchecked;
use libflate::gzip::Encoder;

let plain = b"Hello World!";
let mut buf = Vec::new();
let mut encoder = AutoFinishUnchecked::new(Encoder::new(&mut buf).unwrap());
io::copy(&mut &plain[..], &mut encoder).unwrap();

Returns the immutable reference to the inner stream.

Returns the mutable reference to the inner stream.

Unwraps the Encoder, returning the inner stream.

Trait Implementations

Completes the current processing and returns the result.

Write a buffer into this writer, returning how many bytes were written. Read more

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

Like write, except that it writes from a slice of buffers. Read more

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation. Read more

Attempts to write an entire buffer into this writer. Read more

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer. Read more

Writes a formatted string into this writer, returning any error encountered. Read more

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.