pub struct Encoder<W, E = DefaultLz77Encoder> {
    writer: BitWriter<W>,
    block: Block<E>,
}
Expand description

DEFLATE encoder.

Fields§

§writer: BitWriter<W>§block: Block<E>

Implementations§

source§

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

source

pub fn new(inner: W) -> Self

Makes a new encoder instance.

Encoded DEFLATE stream is written to inner.

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

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

assert_eq!(encoder.finish().into_result().unwrap(),
           [5, 192, 49, 13, 0, 0, 8, 3, 65, 43, 224, 6, 7, 24, 128, 237,
           147, 38, 245, 63, 244, 230, 65, 181, 50, 215, 1]);
source§

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

source

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

Makes a new encoder instance with specified options.

Encoded DEFLATE stream is written to inner.

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

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

assert_eq!(encoder.finish().into_result().unwrap(),
           [1, 12, 0, 243, 255, 72, 101, 108, 108, 111, 32, 87, 111,
            114, 108, 100, 33]);
source

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

Flushes internal buffer and returns the inner stream.

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

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

assert_eq!(encoder.finish().into_result().unwrap(),
           [5, 192, 49, 13, 0, 0, 8, 3, 65, 43, 224, 6, 7, 24, 128, 237,
           147, 38, 245, 63, 244, 230, 65, 181, 50, 215, 1]);
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: Debug, E: Debug> Debug for Encoder<W, E>

source§

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

Formats the value using the given formatter. Read more
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.