Compressor

Struct Compressor 

Source
pub struct Compressor<W: Write>(/* private fields */);
Expand description

An adapter to compress a stream.

Implementations§

Source§

impl<W: Write> Compressor<W>

Source

pub fn new( writer: W, method: CompressionMethod, level: Option<i32>, ) -> Result<Self>

Creates a new Compressor.

The level parameter signification depends on the method used. None always means “default level” and is always supported.

Compression methods unsupported by this crate will cause an error.

Source

pub fn compression_method(&self) -> CompressionMethod

Returns the compression method used by this compressor

Source

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

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

Source

pub fn do_finish(&mut self) -> Result<()>

Attempts to finish the stream.

You must finish the stream when you’re done writing.

Source

pub fn finish(self) -> Result<W>

Finishes the stream and get the writer back.

You must finish the stream when you’re done writing.

Trait Implementations§

Source§

impl<W: Write> Write for Compressor<W>

Source§

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

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

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

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

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

Flushes 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
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, args: 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 Self
where Self: Sized,

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

Auto Trait Implementations§

§

impl<W> Freeze for Compressor<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Compressor<W>
where W: RefUnwindSafe,

§

impl<W> Send for Compressor<W>
where W: Send,

§

impl<W> Sync for Compressor<W>
where W: Sync,

§

impl<W> Unpin for Compressor<W>
where W: Unpin,

§

impl<W> !UnwindSafe for Compressor<W>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where 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 T
where 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 T
where U: Into<T>,

Source§

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 T
where U: TryFrom<T>,

Source§

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.