Struct async_compression::tokio_02::bufread::BzDecoder

source · [−]

pub struct BzDecoder<R> { /* private fields */ }

Available on crate features tokio-02 and bzip2 only.

Expand description

A bzip2 decoder, or decompressor.

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

Implementations

source

impl<R: AsyncBufRead> BzDecoder<R>

source

pub fn new(read: R) -> BzDecoder<R>

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

source

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 EOF or another compressed member/frame to follow it in the stream.

source

pub fn get_ref(&self) -> &R

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

source

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

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.

source

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

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.

source

pub fn into_inner(self) -> R

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

source

impl<R: AsyncBufRead> AsyncRead for BzDecoder<R>

source

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

Attempts to read from the AsyncRead into buf. Read more

source

unsafe fn prepare_uninitialized_buffer(
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out. Read more

source

fn poll_read_buf(
 self: Pin<&mut Self>,
 cx: &mut Context<'_>,
 buf: &mut B
) -> Poll<Result<usize, Error>>where
 B: BufMut,

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read. Read more

source

impl<R: Debug> Debug for BzDecoder<R>

source

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

Formats the value using the given formatter. Read more

source

impl<'pin, R> Unpin for BzDecoder<R>where
Origin<'__pin, R>: Unpin,

Auto Trait Implementations

impl<R> RefUnwindSafe for BzDecoder<R>where
R: RefUnwindSafe,

impl<R> Send for BzDecoder<R>where
R: Send,

impl<R> Sync for BzDecoder<R>where
R: Sync,

impl<R> UnwindSafe for BzDecoder<R>where
R: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

source

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,

Creates a new AsyncRead instance that chains this stream with next. Read more

source

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,

Pulls some bytes from this source into the specified buffer, returning how many bytes were read. Read more

source

fn read_buf(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B>where
Self: Unpin,
B: BufMut,

Pulls some bytes from this source into the specified buffer, advancing the buffer’s internal cursor. Read more

source

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,

Reads the exact number of bytes required to fill buf. Read more

source

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self>where
Self: Unpin,

Reads an unsigned 8 bit integer from the underlying reader. Read more

source

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self>where
Self: Unpin,

Reads a signed 8 bit integer from the underlying reader. Read more

source

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self>where
Self: Unpin,

Reads an unsigned 16-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self>where
Self: Unpin,

Reads a signed 16-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self>where
Self: Unpin,

Reads an unsigned 32-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self>where
Self: Unpin,

Reads a signed 32-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self>where
Self: Unpin,

Reads an unsigned 64-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self>where
Self: Unpin,

Reads an signed 64-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self>where
Self: Unpin,

Reads an unsigned 128-bit integer in big-endian order from the underlying reader. Read more

source

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self>where
Self: Unpin,

Reads an signed 128-bit integer in big-endian order from the underlying reader. Read more

source

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self>where
Self: Unpin,

Reads an unsigned 16-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self>where
Self: Unpin,

Reads a signed 16-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self>where
Self: Unpin,

Reads an unsigned 32-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self>where
Self: Unpin,

Reads a signed 32-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self>where
Self: Unpin,

Reads an unsigned 64-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self>where
Self: Unpin,

Reads an signed 64-bit integer in little-endian order from the underlying reader. Read more

source

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self>where
Self: Unpin,

Reads an unsigned 128-bit integer in little-endian order from the underlying reader. Read more

source

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self>where
Self: Unpin,

Reads an signed 128-bit integer in little-endian order from the underlying reader. Read more

source

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where
Self: Unpin,

Reads all bytes until EOF in this source, placing them into buf. Read more

source

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self>where
Self: Unpin,

Reads all bytes until EOF in this source, appending them to buf. Read more

source

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which reads at most limit bytes from it. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct async_compression::tokio_02::bufread::BzDecoder

Implementations

impl<R: AsyncBufRead> BzDecoder<R>

pub fn new(read: R) -> BzDecoder<R>

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

pub fn get_ref(&self) -> &R

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

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

pub fn into_inner(self) -> R

Trait Implementations

impl<R: AsyncBufRead> AsyncRead for BzDecoder<R>

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

unsafe fn prepare_uninitialized_buffer( &self, buf: &mut [MaybeUninit<u8>]) -> bool

fn poll_read_buf<B>( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut B) -> Poll<Result<usize, Error>>where B: BufMut,

impl<R: Debug> Debug for BzDecoder<R>

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

impl<'__pin, R> Unpin for BzDecoder<R>where __Origin<'__pin, R>: Unpin,

Auto Trait Implementations

impl<R> RefUnwindSafe for BzDecoder<R>where R: RefUnwindSafe,

impl<R> Send for BzDecoder<R>where R: Send,

impl<R> Sync for BzDecoder<R>where R: Sync,

impl<R> UnwindSafe for BzDecoder<R>where R: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for Rwhere R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where R: AsyncRead,

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where Self: Unpin,

fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B>where Self: Unpin, B: BufMut,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where Self: Unpin,

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self>where Self: Unpin,

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self>where Self: Unpin,

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self>where Self: Unpin,

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self>where Self: Unpin,

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self>where Self: Unpin,

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self>where Self: Unpin,

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self>where Self: Unpin,

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self>where Self: Unpin,

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self>where Self: Unpin,

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self>where Self: Unpin,

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self>where Self: Unpin,

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self>where Self: Unpin,

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self>where Self: Unpin,

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self>where Self: Unpin,

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self>where Self: Unpin,

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self>where Self: Unpin,

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self>where Self: Unpin,

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self>where Self: Unpin,

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where Self: Unpin,

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self>where Self: Unpin,

fn take(self, limit: u64) -> Take<Self>

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

unsafe fn prepare_uninitialized_buffer(
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool

fn poll_read_buf<B>(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize, Error>>where
B: BufMut,

impl<'pin, R> Unpin for BzDecoder<R>where
Origin<'__pin, R>: Unpin,

impl<R> RefUnwindSafe for BzDecoder<R>where
R: RefUnwindSafe,

impl<R> Send for BzDecoder<R>where
R: Send,

impl<R> Sync for BzDecoder<R>where
R: Sync,

impl<R> UnwindSafe for BzDecoder<R>where
R: UnwindSafe,

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

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,

fn read_buf<B>(&'a mut self, buf: &'a mut B) -> ReadBuf<'a, Self, B>where
Self: Unpin,
B: BufMut,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,

fn read_u8(&'a mut self) -> ReadU8<&'a mut Self>where
Self: Unpin,

fn read_i8(&'a mut self) -> ReadI8<&'a mut Self>where
Self: Unpin,

fn read_u16(&'a mut self) -> ReadU16<&'a mut Self>where
Self: Unpin,

fn read_i16(&'a mut self) -> ReadI16<&'a mut Self>where
Self: Unpin,

fn read_u32(&'a mut self) -> ReadU32<&'a mut Self>where
Self: Unpin,

fn read_i32(&'a mut self) -> ReadI32<&'a mut Self>where
Self: Unpin,

fn read_u64(&'a mut self) -> ReadU64<&'a mut Self>where
Self: Unpin,

fn read_i64(&'a mut self) -> ReadI64<&'a mut Self>where
Self: Unpin,

fn read_u128(&'a mut self) -> ReadU128<&'a mut Self>where
Self: Unpin,

fn read_i128(&'a mut self) -> ReadI128<&'a mut Self>where
Self: Unpin,

fn read_u16_le(&'a mut self) -> ReadU16Le<&'a mut Self>where
Self: Unpin,

fn read_i16_le(&'a mut self) -> ReadI16Le<&'a mut Self>where
Self: Unpin,

fn read_u32_le(&'a mut self) -> ReadU32Le<&'a mut Self>where
Self: Unpin,

fn read_i32_le(&'a mut self) -> ReadI32Le<&'a mut Self>where
Self: Unpin,

fn read_u64_le(&'a mut self) -> ReadU64Le<&'a mut Self>where
Self: Unpin,

fn read_i64_le(&'a mut self) -> ReadI64Le<&'a mut Self>where
Self: Unpin,

fn read_u128_le(&'a mut self) -> ReadU128Le<&'a mut Self>where
Self: Unpin,

fn read_i128_le(&'a mut self) -> ReadI128Le<&'a mut Self>where
Self: Unpin,

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where
Self: Unpin,

fn read_to_string(&'a mut self, dst: &'a mut String) -> ReadToString<'a, Self>where
Self: Unpin,

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

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

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

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

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