Struct async_compression::futures::write::BrotliDecoder

pub struct BrotliDecoder<W: AsyncWrite> { /* fields omitted */ }

This is supported on feature="futures-write" and feature="brotli" only.

A brotli decoder, or decompressor.

This structure implements an AsyncWrite interface and will take in compressed data and write it uncompressed to an underlying stream.

Methods

impl<W: AsyncWrite> BrotliDecoder<W>

pub fn new(read: W) -> BrotliDecoder<W>

This is supported on feature="futures-write" only.

Creates a new decoder which will take in compressed data and write it uncompressedd to the given stream.

pub fn get_ref(&self) -> &W

This is supported on feature="futures-write" only.

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

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

This is supported on feature="futures-write" only.

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

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

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

This is supported on feature="futures-write" only.

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

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

pub fn into_inner(self) -> W

This is supported on feature="futures-write" only.

Consumes this decoder returning the underlying reader.

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<'__pin, W: AsyncWrite> Unpin for BrotliDecoder<W> where
    __Origin<'__pin, W>: Unpin, 

impl<W: Debug + AsyncWrite> Debug for BrotliDecoder<W>

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

Formats the value using the given formatter.

impl<W: AsyncWrite> AsyncWrite for BrotliDecoder<W>

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

Attempt to write bytes from buf into the object.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.