Struct async_compression::stream::GzipEncoder

pub struct GzipEncoder<S: Stream<Item = Result<Bytes>>> { /* fields omitted */ }

This is supported on feature="stream" and feature="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.

Methods

impl<S: Stream<Item = Result<Bytes>>> GzipEncoder<S>

pub fn new(inner: S, level: Compression) -> Self

This is supported on feature="stream" only.

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

pub fn get_ref(&self) -> &S

This is supported on feature="stream" only.

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

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

This is supported on feature="stream" only.

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>

This is supported on feature="stream" only.

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

This is supported on feature="stream" only.

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<'pin, S: Stream<Item = Result<Bytes>>> Unpin for GzipEncoder<S> where
    __GzipEncoder<'pin, S>: Unpin, 

impl<S: Debug + Stream<Item = Result<Bytes>>> Debug for GzipEncoder<S>

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

Formats the value using the given formatter.

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

type Item = Result<Bytes>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Option<Result<Bytes>>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.