Struct snap::Decoder [−][src]
pub struct Decoder { /* fields omitted */ }
Decoder is a raw decoder for decompressing bytes in the Snappy format.
This decoder does not use the Snappy frame format and simply decompresses
the given bytes as if it were returned from Encoder
.
Unless you explicitly need the low-level control, you should use
Reader
instead, which decompresses the Snappy frame format.
Methods
impl Decoder
[src]
impl Decoder
pub fn new() -> Decoder
[src]
pub fn new() -> Decoder
Return a new decoder that can be used for decompressing bytes.
pub fn decompress(&mut self, input: &[u8], output: &mut [u8]) -> Result<usize>
[src]
pub fn decompress(&mut self, input: &[u8], output: &mut [u8]) -> Result<usize>
Decompresses all bytes in input
into output
.
input
must be a sequence of bytes returned by a conforming Snappy
compressor.
The size of output
must be large enough to hold all decompressed
bytes from the input
. The size required can be queried with the
decompress_len
function.
On success, this returns the number of bytes written to output
.
Errors
This method returns an error in the following circumstances:
- Invalid compressed Snappy data was seen.
- The total space required for decompression exceeds
2^32 - 1
. output
has length less thandecompress_len(input)
.
pub fn decompress_vec(&mut self, input: &[u8]) -> Result<Vec<u8>>
[src]
pub fn decompress_vec(&mut self, input: &[u8]) -> Result<Vec<u8>>
Decompresses all bytes in input
into a freshly allocated Vec
.
This is just like the decompress
method, except it allocates a Vec
with the right size for you. (This is intended to be a convenience
method.)
This method returns an error under the same circumstances that
decompress
does.
Trait Implementations
impl Clone for Decoder
[src]
impl Clone for Decoder
fn clone(&self) -> Decoder
[src]
fn clone(&self) -> Decoder
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for Decoder
[src]
impl Debug for Decoder
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Default for Decoder
[src]
impl Default for Decoder