[][src]Struct async_compression::stream::LzmaDecoder

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

A lzma 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>>> LzmaDecoder<S>[src]

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

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)[src]

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[src]

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

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

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>[src]

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[src]

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 LzmaDecoder<S>[src]

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

type Item = Result<Bytes>

Values yielded by the stream.

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

Auto Trait Implementations

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

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

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

impl<S> UnwindSafe for LzmaDecoder<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