Struct zstd::stream::zio::Reader

source ·
pub struct Reader<R, D> { /* private fields */ }
Expand description

Implements the Read API around an Operation.

This can be used to wrap a raw in-memory operation in a read-focused API.

It can wrap either a compression or decompression operation, and pulls input data from a wrapped Read.

Implementations§

source§

impl<R, D> Reader<R, D>

source

pub fn new(reader: R, operation: D) -> Self

Creates a new Reader.

reader will be used to pull input data for the given operation.

source

pub fn set_single_frame(&mut self)

Sets self to stop after the first decoded frame.

source

pub fn operation_mut(&mut self) -> &mut D

Returns a mutable reference to the underlying operation.

source

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

Returns a mutable reference to the underlying reader.

source

pub fn reader(&self) -> &R

Returns a reference to the underlying reader.

source

pub fn into_inner(self) -> R

Returns the inner reader.

source

pub fn flush(&mut self, output: &mut [u8]) -> Result<usize>
where D: Operation,

Flush any internal buffer.

For encoders, this ensures all input consumed so far is compressed.

Trait Implementations§

source§

impl<R, D> Read for Reader<R, D>
where R: BufRead, D: Operation,

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

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

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

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

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<R, D> Freeze for Reader<R, D>
where R: Freeze, D: Freeze,

§

impl<R, D> RefUnwindSafe for Reader<R, D>

§

impl<R, D> Send for Reader<R, D>
where R: Send, D: Send,

§

impl<R, D> Sync for Reader<R, D>
where R: Sync, D: Sync,

§

impl<R, D> Unpin for Reader<R, D>
where R: Unpin, D: Unpin,

§

impl<R, D> UnwindSafe for Reader<R, D>
where R: UnwindSafe, D: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.