Struct zstd::stream::Decoder
[−]
[src]
pub struct Decoder<R: Read> { /* fields omitted */ }
A decoder that decompress input data from another Read
.
This allows to read a stream of compressed data (good for files or heavy network stream).
Methods
impl<R: Read> Decoder<R>
[src]
pub fn new(reader: R) -> Result<Self>
[src]
Creates a new decoder.
pub fn single_frame(self) -> Self
[src]
Sets this Decoder
to stop after the first frame.
By default, it keeps concatenating frames until EOF is reached.
pub fn with_dictionary(reader: R, dictionary: &[u8]) -> Result<Self>
[src]
Creates a new decoder, using an existing dictionary.
The dictionary must be the same as the one used during compression.
pub fn recommended_output_size() -> usize
[src]
Recommendation for the size of the output buffer.
pub fn get_ref(&self) -> &R
[src]
Acquire a reference to the underlying reader.
pub fn get_mut(&mut self) -> &mut R
[src]
Acquire a mutable reference to the underlying reader.
Note that mutation of the reader may result in surprising results if this decoder is continued to be used.
pub fn finish(self) -> R
[src]
Return the inner Read
.
Calling finish()
is not required after reading a stream -
just use it if you need to get the Read
back.
Trait Implementations
impl<R: Read> Read for Decoder<R>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
read_initializer
)Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0[src]
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self>
[src]
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
Creates an adaptor which will read at most limit
bytes from it. Read more