Struct async_compression::stream::GzipDecoder

pub struct GzipDecoder<S> { /* fields omitted */ }

A gzip decoder, or decompressor.

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

Implementations

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

pub fn new(stream: S) -> Self

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

pub fn multiple_members(&mut self, enabled: bool)

Configure multi-member/frame decoding, if enabled this will reset the decoder state when reaching the end of a compressed member/frame and expect either the end of the wrapped stream or another compressed member/frame to follow.

pub fn get_ref(&self) -> &S

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

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

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

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

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

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

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

pub fn into_inner(self) -> S

Consumes this decoder returning the underlying stream.

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

Trait Implementations

impl<S: Debug> Debug for GzipDecoder<S>

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

Formats the value using the given formatter.

impl<S: Stream<Item = Result<Bytes>>> Stream for GzipDecoder<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.

impl<'__pin, S> Unpin for GzipDecoder<S> where
    __Origin<'__pin, S>: Unpin,