Struct async_compression::stream::XzDecoder

source · [−]

pub struct XzDecoder<S> { /* private fields */ }

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

This is supported on crate features stream and xz only.

Expand description

A xz 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

source

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

source

pub fn new(stream: S) -> Self

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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

source

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

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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.

source

pub fn get_ref(&self) -> &S

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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

source

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

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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.

source

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

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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.

source

pub fn into_inner(self) -> S

👎 Deprecated since 0.3.8:

See async-compression::stream docs for migration

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

source

impl<S: Debug> Debug for XzDecoder<S>

source

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

Formats the value using the given formatter. Read more

source

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

type Item = Result<Bytes>

Values yielded by the stream.

source

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. Read more

source

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

Returns the bounds on the remaining length of the stream. Read more

source

impl<'pin, S> Unpin for XzDecoder<S> where
Origin<'__pin, S>: Unpin,

Auto Trait Implementations

impl<S> RefUnwindSafe for XzDecoder<S> where
S: RefUnwindSafe,

impl<S> Send for XzDecoder<S> where
S: Send,

impl<S> Sync for XzDecoder<S> where
S: Sync,

impl<S> UnwindSafe for XzDecoder<S> where
S: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<St> StreamExt for St where
St: Stream + ?Sized,

source

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

Consumes and returns the next value in the stream or None if the stream is finished. Read more

source

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

source

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

source

fn merge(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by interleaving the output of both as it is produced. Read more

source

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

Filters the values produced by this stream according to the provided predicate. Read more

source

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

source

fn fuse(self) -> Fuse<Self>

Creates a stream which ends after the first None. Read more

source

fn take(self, n: usize) -> Take<Self>

Creates a new stream of at most n items of the underlying stream. Read more

source

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Take elements from this stream while the provided predicate resolves to true. Read more

source

fn skip(self, n: usize) -> Skip<Self>

Creates a new stream that will skip the n first items of the underlying stream. Read more

source

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

source

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if every element of the stream matches a predicate. Read more

source

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if any element of the stream matches a predicate. Read more

source

fn chain(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

source

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,

A combinator that applies a function to every element in a stream producing a single, final value. Read more

source

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

Drain stream pushing all emitted values into a collection. Read more

source

impl<St> StreamExt for St where
St: Stream + ?Sized,

source

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

Consumes and returns the next value in the stream or None if the stream is finished. Read more

source

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

source

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

source

fn merge(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by interleaving the output of both as it is produced. Read more

source

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

Filters the values produced by this stream according to the provided predicate. Read more

source

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

source

fn fuse(self) -> Fuse<Self>

Creates a stream which ends after the first None. Read more

source

fn take(self, n: usize) -> Take<Self>

Creates a new stream of at most n items of the underlying stream. Read more

source

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Take elements from this stream while the provided predicate resolves to true. Read more

source

fn skip(self, n: usize) -> Skip<Self>

Creates a new stream that will skip the n first items of the underlying stream. Read more

source

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

source

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if every element of the stream matches a predicate. Read more

source

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

Tests if any element of the stream matches a predicate. Read more

source

fn chain(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

source

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,

A combinator that applies a function to every element in a stream producing a single, final value. Read more

source

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

Drain stream pushing all emitted values into a collection. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more

Struct async_compression::stream::XzDecoder

Implementations

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

pub fn new(stream: S) -> Self

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

pub fn get_ref(&self) -> &S

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

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

pub fn into_inner(self) -> S

Trait Implementations

impl<S: Debug> Debug for XzDecoder<S>

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

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

type Item = Result<Bytes>

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

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

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

Auto Trait Implementations

impl<S> RefUnwindSafe for XzDecoder<S> where S: RefUnwindSafe,

impl<S> Send for XzDecoder<S> where S: Send,

impl<S> Sync for XzDecoder<S> where S: Sync,

impl<S> UnwindSafe for XzDecoder<S> where S: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<St> StreamExt for St where St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<T>,

fn fuse(self) -> Fuse<Self>

fn take(self, n: usize) -> Take<Self>

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn skip(self, n: usize) -> Skip<Self>

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where U: Stream<Item = Self::Item>,

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where F: FnMut(B, Self::Item) -> B,

fn collect<T>(self) -> Collect<Self, T> where T: FromStream<Self::Item>,

impl<St> StreamExt for St where St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where F: FnMut(Self::Item) -> Option<T>,

fn fuse(self) -> Fuse<Self>

fn take(self, n: usize) -> Take<Self>

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn skip(self, n: usize) -> Skip<Self>

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where Self: Unpin, F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where U: Stream<Item = Self::Item>,

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where F: FnMut(B, Self::Item) -> B,

fn collect<T>(self) -> Collect<Self, T> where T: FromStream<Self::Item>,

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

type Ok = T

type Error = E

pub fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

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

impl<'pin, S> Unpin for XzDecoder<S> where
Origin<'__pin, S>: Unpin,

impl<S> RefUnwindSafe for XzDecoder<S> where
S: RefUnwindSafe,

impl<S> Send for XzDecoder<S> where
S: Send,

impl<S> Sync for XzDecoder<S> where
S: Sync,

impl<S> UnwindSafe for XzDecoder<S> where
S: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<St> StreamExt for St where
St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

impl<St> StreamExt for St where
St: Stream + ?Sized,

fn next(&mut self) -> Next<'_, Self> where
Self: Unpin,

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
Self: Stream<Item = Result<T, E>> + Unpin,

fn map<T, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> T,

fn merge<U>(self, other: U) -> Merge<Self, U> where
U: Stream<Item = Self::Item>,

fn filter<F>(self, f: F) -> Filter<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<T>,

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
F: FnMut(&Self::Item) -> bool,

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
Self: Unpin,
F: FnMut(Self::Item) -> bool,

fn chain<U>(self, other: U) -> Chain<Self, U> where
U: Stream<Item = Self::Item>,

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
F: FnMut(B, Self::Item) -> B,

fn collect<T>(self) -> Collect<Self, T> where
T: FromStream<Self::Item>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

pub fn try_poll_next(
self: Pin<&mut S>,
cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>