pub struct Encoder<'a> { /* private fields */ }
Expand description
An in-memory encoder for streams of data.
Implementations
sourceimpl<'a> Encoder<'a>
impl<'a> Encoder<'a>
sourcepub fn with_prepared_dictionary<'b>(
dictionary: &EncoderDictionary<'b>
) -> Result<Self> where
'b: 'a,
pub fn with_prepared_dictionary<'b>(
dictionary: &EncoderDictionary<'b>
) -> Result<Self> where
'b: 'a,
Creates a new encoder using an existing EncoderDictionary
.
sourcepub fn set_parameter(&mut self, parameter: CParameter) -> Result<()>
pub fn set_parameter(&mut self, parameter: CParameter) -> Result<()>
Sets a compression parameter for this encoder.
sourcepub fn set_pledged_src_size(&mut self, pledged_src_size: u64) -> Result<()>
pub fn set_pledged_src_size(&mut self, pledged_src_size: u64) -> Result<()>
Sets the size of the input expected by zstd.
May affect compression ratio.
It is an error to give an incorrect size (an error will be returned when closing the stream).
Trait Implementations
sourceimpl<'a> Operation for Encoder<'a>
impl<'a> Operation for Encoder<'a>
sourcefn run<C: WriteBuf + ?Sized>(
&mut self,
input: &mut InBuffer<'_>,
output: &mut OutBuffer<'_, C>
) -> Result<usize>
fn run<C: WriteBuf + ?Sized>(
&mut self,
input: &mut InBuffer<'_>,
output: &mut OutBuffer<'_, C>
) -> Result<usize>
Performs a single step of this operation. Read more
sourcefn flush<C: WriteBuf + ?Sized>(
&mut self,
output: &mut OutBuffer<'_, C>
) -> Result<usize>
fn flush<C: WriteBuf + ?Sized>(
&mut self,
output: &mut OutBuffer<'_, C>
) -> Result<usize>
Flushes any internal buffer, if any. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Encoder<'a>
impl<'a> Send for Encoder<'a>
impl<'a> !Sync for Encoder<'a>
impl<'a> Unpin for Encoder<'a>
impl<'a> UnwindSafe for Encoder<'a>
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