[−]Struct async_compression::stream::ZlibEncoder

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

This is supported on feature="stream" and feature="zlib" only.

A zlib 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>>> ZlibEncoder<S>`[src]

`pub fn get_ref(&self) -> &S`[src]

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

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<'a>(self: Pin<&'a mut Self>) -> Pin<&'a mut S>`[src]

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

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.

`impl<S: Stream<Item = Result<Bytes>>> ZlibEncoder<S>`[src]

`pub fn new(stream: S, level: Compression) -> Self`[src]

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.

Trait Implementations

`impl<S: Stream<Item = Result<Bytes>>> Unpin for ZlibEncoder<S> where Encoder<S, ZlibEncoder>: Unpin,` [src]

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

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

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

`type Item = Result<Bytes>`

Values yielded by the stream.

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

Auto Trait Implementations

`impl<S> Send for ZlibEncoder<S> where S: Send,`

`impl<S> Sync for ZlibEncoder<S> where S: Sync,`

`impl<S> UnwindSafe for ZlibEncoder<S> where S: UnwindSafe,`

`impl<S> RefUnwindSafe for ZlibEncoder<S> where S: RefUnwindSafe,`

Blanket Implementations

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[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.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`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.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`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

`fn try_poll_next( self: Pin<&mut S>, cx: &mut Context ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>`[src]

`impl<T> StreamExt for T where T: Stream + ?Sized,` [src]

`fn next(&mut self) -> Next<Self> where Self: Unpin,` [src]

`fn into_future(self) -> StreamFuture<Self> where Self: Unpin,` [src]

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

`fn enumerate(self) -> Enumerate<Self>`[src]

`fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,` [src]

`fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = Option<T>>,` [src]

`fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future,` [src]

`fn collect<C>(self) -> Collect<Self, C> where C: Default + Extend<Self::Item>,` [src]

`fn concat(self) -> Concat<Self> where Self::Item: Extend<<Self::Item as IntoIterator>::Item>, Self::Item: IntoIterator, Self::Item: Default,` [src]

`fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where F: FnMut(T, Self::Item) -> Fut, Fut: Future<Output = T>,` [src]

`fn flatten(self) -> Flatten<Self> where Self::Item: Stream,` [src]

`fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,` [src]

`fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where F: FnMut(&Self::Item) -> Fut, Fut: Future<Output = bool>,` [src]

`fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>,` [src]

`fn for_each_concurrent<Fut, F>( self, limit: impl Into<Option<usize>>, f: F ) -> ForEachConcurrent<Self, Fut, F> where F: FnMut(Self::Item) -> Fut, Fut: Future<Output = ()>,` [src]

`fn take(self, n: u64) -> Take<Self>`[src]

`fn skip(self, n: u64) -> Skip<Self>`[src]

`fn fuse(self) -> Fuse<Self>`[src]

`fn by_ref(&mut self) -> &mut Self`[src]

`fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,` [src]

`fn boxed<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send>> where Self: Send + 'a,` [src]

`fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a>> where Self: 'a,` [src]

`fn buffered(self, n: usize) -> Buffered<Self> where Self::Item: Future,` [src]

`fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where Self::Item: Future,` [src]

`fn zip<St>(self, other: St) -> Zip<Self, St> where St: Stream,` [src]

`fn chain<St>(self, other: St) -> Chain<Self, St> where St: Stream<Item = Self::Item>,` [src]

`fn peekable(self) -> Peekable<Self>`[src]

`fn chunks(self, capacity: usize) -> Chunks<Self>`[src]

`fn forward<S>(self, sink: S) -> Forward<Self, S> where S: Sink<Self::Ok>, Self: TryStream<Error = <S as Sink<Self::Ok>>::Error>,` [src]

`fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where Self: Sink<Item>,` [src]

`fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnMut(&Self::Item),` [src]

`fn left_stream<B>(self) -> Either<Self, B> where B: Stream<Item = Self::Item>,` [src]

`fn right_stream<B>(self) -> Either<B, Self> where B: Stream<Item = Self::Item>,` [src]

`fn poll_next_unpin(&mut self, cx: &mut Context) -> Poll<Option<Self::Item>> where Self: Unpin,` [src]

`fn select_next_some(&mut self) -> SelectNextSome<Self> where Self: Unpin + FusedStream,` [src]

`impl<S> TryStreamExt for S where S: TryStream + ?Sized,` [src]

`fn err_into<E>(self) -> ErrInto<Self, E> where Self::Error: Into<E>,` [src]

`fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where F: FnMut(Self::Ok) -> T,` [src]

`fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where F: FnMut(Self::Error) -> E,` [src]

`fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>,` [src]

`fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where F: FnMut(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>,` [src]

`fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where F: FnMut(&Self::Ok),` [src]

`fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where F: FnMut(&Self::Error),` [src]

`fn into_stream(self) -> IntoStream<Self>`[src]

`fn try_next(&mut self) -> TryNext<Self> where Self: Unpin,` [src]

`fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Ok = (), Error = Self::Error>,` [src]

`fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where F: FnMut(&Self::Ok) -> Fut, Fut: TryFuture<Ok = bool, Error = Self::Error>,` [src]

`fn try_for_each_concurrent<Fut, F>( self, limit: impl Into<Option<usize>>, f: F ) -> TryForEachConcurrent<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: Future<Output = Result<(), Self::Error>>,` [src]

`fn try_collect<C>(self) -> TryCollect<Self, C> where C: Default + Extend<Self::Ok>,` [src]

`fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F> where F: FnMut(&Self::Ok) -> Fut, Fut: Future<Output = bool>,` [src]

`fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where F: FnMut(Self::Ok) -> Fut, Fut: TryFuture<Ok = Option<T>, Error = Self::Error>,` [src]

`fn try_flatten(self) -> TryFlatten<Self> where Self::Ok: TryStream, <Self::Ok as TryStream>::Error: From<Self::Error>,` [src]

`fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where F: FnMut(T, Self::Ok) -> Fut, Fut: TryFuture<Ok = T, Error = Self::Error>,` [src]

`fn try_concat(self) -> TryConcat<Self> where Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>, Self::Ok: IntoIterator, Self::Ok: Default,` [src]

`fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where Self::Ok: TryFuture, <Self::Ok as TryFuture>::Error == Self::Error,` [src]

`fn try_poll_next_unpin( &mut self, cx: &mut Context ) -> Poll<Option<Result<Self::Ok, Self::Error>>> where Self: Unpin,` [src]

`fn into_async_read(self) -> IntoAsyncRead<Self> where Self: TryStreamExt<Error = Error> + Unpin, Self::Ok: AsRef<[u8]>,` [src]