Struct libflate::gzip::Encoder

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

GZIP encoder.

Fields§

§header: Header§crc32: Crc32§input_size: u32§writer: Encoder<W, E>

Implementations§

source§

impl<W> Encoder<W, DefaultLz77Encoder>where W: Write,

source

pub fn new(inner: W) -> Result<Self>

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();
source§

impl<W, E> Encoder<W, E>where W: Write, E: Lz77Encode,

source

pub fn with_options(inner: W, options: EncodeOptions<E>) -> Result<Self>

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][..]);
source

pub fn header(&self) -> &Header

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);
source

pub fn finish(self) -> Finish<W, Error>

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();
source

pub fn as_inner_ref(&self) -> &W

Returns the immutable reference to the inner stream.

source

pub fn as_inner_mut(&mut self) -> &mut W

Returns the mutable reference to the inner stream.

source

pub fn into_inner(self) -> W

Unwraps the Encoder, returning the inner stream.

Trait Implementations§

source§

impl<W, E> Complete for Encoder<W, E>where W: Write, E: Lz77Encode,

source§

fn complete(self) -> Result<()>

Completes the current processing and returns the result.
source§

impl<W, E> Write for Encoder<W, E>where W: Write, E: Lz77Encode,

source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

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

fn flush(&mut self) -> Result<()>

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

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

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

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

Auto Trait Implementations§

§

impl<W, E> RefUnwindSafe for Encoder<W, E>where E: RefUnwindSafe, W: RefUnwindSafe,

§

impl<W, E> Send for Encoder<W, E>where E: Send, W: Send,

§

impl<W, E> Sync for Encoder<W, E>where E: Sync, W: Sync,

§

impl<W, E> Unpin for Encoder<W, E>where E: Unpin, W: Unpin,

§

impl<W, E> UnwindSafe for Encoder<W, E>where E: UnwindSafe, W: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.