Skip to main content

DeflateEncoder

Struct DeflateEncoder 

Source
pub struct DeflateEncoder<R> { /* private fields */ }
Available on crate feature deflate only.
Expand description

A deflate encoder, or compressor.

This structure implements an AsyncRead interface and will read uncompressed data from an underlying stream and emit a stream of compressed data.

Implementations§

Source§

impl<R: AsyncBufRead> DeflateEncoder<R>

Source

pub fn new(inner: R) -> Self

Available on crate feature futures-io only.

Creates a new encoder which will read uncompressed data from the given stream and emit a compressed stream.

Source

pub fn with_quality(inner: R, level: Level) -> Self

Available on crate feature futures-io only.

Creates a new encoder which will read uncompressed data from the given stream and emit a compressed stream.

Source

pub fn get_ref(&self) -> &R

Available on crate feature futures-io only.

Acquires a reference to the underlying reader that this encoder is wrapping.

Source

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

Available on crate feature futures-io only.

Acquires a mutable reference to the underlying reader that this encoder is wrapping.

Note that care must be taken to avoid tampering with the state of the reader which may otherwise confuse this encoder.

Source

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

Available on crate feature futures-io only.

Acquires a pinned mutable reference to the underlying reader that this encoder is wrapping.

Note that care must be taken to avoid tampering with the state of the reader which may otherwise confuse this encoder.

Source

pub fn into_inner(self) -> R

Available on crate feature futures-io only.

Consumes this encoder returning the underlying reader.

Note that this may discard internal state of this encoder, so care should be taken to avoid losing resources when this is called.

Trait Implementations§

Source§

impl<R: AsyncBufRead> AsyncRead for DeflateEncoder<R>

Available on crate feature futures-io only.
Source§

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf. Read more
Source§

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations. Read more
Source§

impl<R: Debug> Debug for DeflateEncoder<R>

Available on crate feature futures-io only.
Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'__pin, R> Unpin for DeflateEncoder<R>
where PinnedFieldsOf<__Origin<'__pin, R>>: Unpin,

Available on crate feature futures-io only.

Auto Trait Implementations§

§

impl<R> Freeze for DeflateEncoder<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for DeflateEncoder<R>
where R: RefUnwindSafe,

§

impl<R> Send for DeflateEncoder<R>
where R: Send,

§

impl<R> Sync for DeflateEncoder<R>
where R: Sync,

§

impl<R> UnsafeUnpin for DeflateEncoder<R>
where R: UnsafeUnpin,

§

impl<R> UnwindSafe for DeflateEncoder<R>
where R: UnwindSafe,

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.