[][src]Struct async_compression::stream::GzipEncoder

pub struct GzipEncoder<S> { /* fields omitted */ }
This is supported on crate features stream and gzip only.

A gzip encoder, or compressor.

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

Implementations

impl<S: Stream<Item = Result<Bytes>>> GzipEncoder<S>[src]

pub fn new(inner: S) -> Self[src]

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

pub fn with_quality(inner: S, level: Level) -> Self[src]

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

pub fn get_ref(&self) -> &S[src]

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

pub fn get_mut(&mut self) -> &mut S[src]

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

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut S>[src]

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

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

pub fn into_inner(self) -> S[src]

Consumes this encoder returning the underlying stream.

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

impl<S: Debug> Debug for GzipEncoder<S>[src]

impl<S: Stream<Item = Result<Bytes>>> Stream for GzipEncoder<S>[src]

type Item = Result<Bytes>

Values yielded by the stream.

impl<'__pin, S> Unpin for GzipEncoder<S> where
    __Origin<'__pin, S>: Unpin
[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for GzipEncoder<S> where
    S: RefUnwindSafe
[src]

impl<S> Send for GzipEncoder<S> where
    S: Send
[src]

impl<S> Sync for GzipEncoder<S> where
    S: Sync
[src]

impl<S> UnwindSafe for GzipEncoder<S> where
    S: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future