Struct zstd::bulk::Decompressor
source · pub struct Decompressor<'a> { /* private fields */ }
Expand description
Allows to decompress independently multiple blocks of data.
This reduces memory usage compared to calling decompress
multiple times.
Implementations§
source§impl Decompressor<'static>
impl Decompressor<'static>
source§impl<'a> Decompressor<'a>
impl<'a> Decompressor<'a>
sourcepub fn with_prepared_dictionary<'b>(
dictionary: &'a DecoderDictionary<'b>,
) -> Result<Self>where
'b: 'a,
pub fn with_prepared_dictionary<'b>(
dictionary: &'a DecoderDictionary<'b>,
) -> Result<Self>where
'b: 'a,
Creates a new decompressor using an existing DecoderDictionary
.
Note that using a dictionary means that compression will need to use the same dictionary.
sourcepub fn set_dictionary(&mut self, dictionary: &[u8]) -> Result<()>
pub fn set_dictionary(&mut self, dictionary: &[u8]) -> Result<()>
Changes the dictionary used by this decompressor.
Will affect future compression jobs.
Note that using a dictionary means that compression will need to use the same dictionary.
sourcepub fn set_prepared_dictionary<'b>(
&mut self,
dictionary: &'a DecoderDictionary<'b>,
) -> Result<()>where
'b: 'a,
pub fn set_prepared_dictionary<'b>(
&mut self,
dictionary: &'a DecoderDictionary<'b>,
) -> Result<()>where
'b: 'a,
Changes the dictionary used by this decompressor.
Note that using a dictionary means that compression will need to use the same dictionary.
sourcepub fn decompress_to_buffer<C: WriteBuf + ?Sized>(
&mut self,
source: &[u8],
destination: &mut C,
) -> Result<usize>
pub fn decompress_to_buffer<C: WriteBuf + ?Sized>( &mut self, source: &[u8], destination: &mut C, ) -> Result<usize>
Deompress a single block of data to the given destination buffer.
Returns the number of bytes written, or an error if something happened (for instance if the destination buffer was too small).
sourcepub fn decompress(&mut self, data: &[u8], capacity: usize) -> Result<Vec<u8>>
pub fn decompress(&mut self, data: &[u8], capacity: usize) -> Result<Vec<u8>>
Decompress a block of data, and return the result in a Vec<u8>
.
The decompressed data should be at most capacity
bytes,
or an error will be returned.
sourcepub fn set_parameter(&mut self, parameter: DParameter) -> Result<()>
pub fn set_parameter(&mut self, parameter: DParameter) -> Result<()>
Sets a decompression parameter for this decompressor.
sourcepub fn window_log_max(&mut self, log_distance: u32) -> Result<()>
pub fn window_log_max(&mut self, log_distance: u32) -> Result<()>
Sets the maximum back-reference distance.
The actual maximum distance is going to be 2^log_distance
.
This will need to at least match the value set when compressing.
sourcepub fn upper_bound(_data: &[u8]) -> Option<usize>
pub fn upper_bound(_data: &[u8]) -> Option<usize>
Get an upper bound on the decompressed size of data, if available
This can be used to pre-allocate enough capacity for decompress_to_buffer
and is used by decompress
to ensure that it does not over-allocate if
you supply a large capacity
.
Will return None
if the upper bound cannot be determined or is larger than usize::MAX
Note that unless the experimental
feature is enabled, this will always return None
.