pub struct Encoder<'a> { /* private fields */ }
Expand description
An in-memory encoder for streams of data.
Implementations§
source§impl<'a> Encoder<'a>
impl<'a> Encoder<'a>
sourcepub fn with_context(context: &'a mut CCtx<'static>) -> Self
pub fn with_context(context: &'a mut CCtx<'static>) -> Self
Creates a new encoder that uses the provided context for serialization.
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 with_ref_prefix<'b>(level: i32, ref_prefix: &'b [u8]) -> Result<Self>where
'b: 'a,
pub fn with_ref_prefix<'b>(level: i32, ref_prefix: &'b [u8]) -> Result<Self>where
'b: 'a,
Creates a new encoder initialized with the given ref prefix.
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: Option<u64>,
) -> Result<()>
pub fn set_pledged_src_size( &mut self, pledged_src_size: Option<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).
If None
is given, it assume the size is not known (default behaviour).
Trait Implementations§
source§impl<'a> Operation for Encoder<'a>
impl<'a> Operation for Encoder<'a>
source§fn 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
source§fn 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> Freeze for Encoder<'a>
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more