Struct libdeflater::Compressor
source · [−]pub struct Compressor { /* private fields */ }
Expand description
A libdeflate
compressor that can compress arbitrary data into
DEFLATE, zlib, or gzip formats.
Implementations
sourceimpl Compressor
impl Compressor
sourcepub fn new(lvl: CompressionLvl) -> Compressor
pub fn new(lvl: CompressionLvl) -> Compressor
Returns a newly constructed Compressor
that compresses data
with the supplied
CompressionLvl
sourcepub fn deflate_compress_bound(&mut self, n_bytes: usize) -> usize
pub fn deflate_compress_bound(&mut self, n_bytes: usize) -> usize
Returns the maximum number of bytes required to encode
n_bytes
as deflate
data. This is a hard upper-bound that assumes the worst
possible compression ratio (i.e. assumes the data cannot be
compressed), format overhead, etc.
sourcepub fn deflate_compress(
&mut self,
in_raw_data: &[u8],
out_deflate_data: &mut [u8]
) -> Result<usize, CompressionError>
pub fn deflate_compress(
&mut self,
in_raw_data: &[u8],
out_deflate_data: &mut [u8]
) -> Result<usize, CompressionError>
Compresses in_raw_data
as
deflate
data, writing
the data into out_deflate_data
. Returns the number of bytes
written into out_deflate_data
.
sourcepub fn zlib_compress_bound(&mut self, n_bytes: usize) -> usize
pub fn zlib_compress_bound(&mut self, n_bytes: usize) -> usize
Returns the maximum number of bytes required to encode
n_bytes
as zlib
data. This is a hard upper-bound that assumes the worst
possible compression ratio (i.e. assumes the data cannot be
compressed), format overhead, etc.
sourcepub fn zlib_compress(
&mut self,
in_raw_data: &[u8],
out_zlib_data: &mut [u8]
) -> Result<usize, CompressionError>
pub fn zlib_compress(
&mut self,
in_raw_data: &[u8],
out_zlib_data: &mut [u8]
) -> Result<usize, CompressionError>
Compresses in_raw_data
as
zlib
data, writing
the data into out_zlib_data
. Returns the number of bytes
written into out_zlib_data
.
sourcepub fn gzip_compress_bound(&mut self, n_bytes: usize) -> usize
pub fn gzip_compress_bound(&mut self, n_bytes: usize) -> usize
Returns the maximum number of bytes required to encode
n_bytes
as gzip
data. This is a hard upper-bound that assumes the worst
possible compression ratio (i.e. assumes the data cannot be
compressed), format overhead, etc.
sourcepub fn gzip_compress(
&mut self,
in_raw_data: &[u8],
out_gzip_data: &mut [u8]
) -> Result<usize, CompressionError>
pub fn gzip_compress(
&mut self,
in_raw_data: &[u8],
out_gzip_data: &mut [u8]
) -> Result<usize, CompressionError>
Compresses in_raw_data
as
gzip
data, writing
the data into out_gzip_data
. Returns the number of bytes
written into out_gzip_data
.
Trait Implementations
sourceimpl Drop for Compressor
impl Drop for Compressor
impl Send for Compressor
Auto Trait Implementations
impl RefUnwindSafe for Compressor
impl !Sync for Compressor
impl Unpin for Compressor
impl UnwindSafe for Compressor
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more