Struct ZstdCodec

pub struct ZstdCodec { /* private fields */ }

Available on crate feature zstd only.

A zstd codec implementation.

Implementations

impl ZstdCodec

pub const fn new(compression: CompressionLevel, checksum: bool) -> Self

Create a new Zstd codec.

pub fn new_with_configuration( configuration: &ZstdCodecConfiguration, ) -> Result<Self, PluginCreateError>

Create a new Zstd codec from configuration.

Errors

Returns an error if the configuration is not supported.

Trait Implementations

impl BytesToBytesCodecTraits for ZstdCodec

fn into_dyn(self: Arc<Self>) -> Arc<dyn BytesToBytesCodecTraits>

Return a dynamic version of the codec.

fn recommended_concurrency( &self, _decoded_representation: &BytesRepresentation, ) -> Result<RecommendedConcurrency, CodecError>

Return the maximum internal concurrency supported for the requested decoded representation.

fn encode<'a>( &self, decoded_value: RawBytes<'a>, _options: &CodecOptions, ) -> Result<RawBytes<'a>, CodecError>

Encode chunk bytes.

fn decode<'a>( &self, encoded_value: RawBytes<'a>, _decoded_representation: &BytesRepresentation, _options: &CodecOptions, ) -> Result<RawBytes<'a>, CodecError>

Decode chunk bytes.

fn encoded_representation( &self, decoded_representation: &BytesRepresentation, ) -> BytesRepresentation

Returns the size of the encoded representation given a size of the decoded representation.

fn partial_decoder( self: Arc<Self>, input_handle: Arc<dyn BytesPartialDecoderTraits>, decoded_representation: &BytesRepresentation, options: &CodecOptions, ) -> Result<Arc<dyn BytesPartialDecoderTraits>, CodecError>

Initialises a partial decoder.

fn partial_encoder( self: Arc<Self>, input_handle: Arc<dyn BytesPartialDecoderTraits>, output_handle: Arc<dyn BytesPartialEncoderTraits>, decoded_representation: &BytesRepresentation, options: &CodecOptions, ) -> Result<Arc<dyn BytesPartialEncoderTraits>, CodecError>

Initialise a partial encoder.

fn async_partial_decoder<'life0, 'life1, 'async_trait>( self: Arc<Self>, input_handle: Arc<dyn AsyncBytesPartialDecoderTraits>, decoded_representation: &'life0 BytesRepresentation, options: &'life1 CodecOptions, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn AsyncBytesPartialDecoderTraits>, CodecError>> + Send + 'async_trait>>

where Self: Sync + Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature async only.

Initialises an asynchronous partial decoder.

fn async_partial_encoder<'life0, 'life1, 'async_trait>( self: Arc<Self>, input_handle: Arc<dyn AsyncBytesPartialDecoderTraits>, output_handle: Arc<dyn AsyncBytesPartialEncoderTraits>, decoded_representation: &'life0 BytesRepresentation, options: &'life1 CodecOptions, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn AsyncBytesPartialEncoderTraits>, CodecError>> + Send + 'async_trait>>

where Self: Sync + Send + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature async only.

Initialise an asynchronous partial encoder.

impl Clone for ZstdCodec

fn clone(&self) -> ZstdCodec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CodecTraits for ZstdCodec

fn identifier(&self) -> &str

Unique identifier for the codec.

fn configuration_opt( &self, _name: &str, _options: &CodecMetadataOptions, ) -> Option<Configuration>

Create the codec configuration.

fn partial_decoder_should_cache_input(&self) -> bool

Indicates if the input to a codecs partial decoder should be cached for optimal performance. If true, a cache may be inserted before it in a CodecChain partial decoder.

fn partial_decoder_decodes_all(&self) -> bool

Indicates if a partial decoder decodes all bytes from its input handle and its output should be cached for optimal performance. If true, a cache will be inserted at some point after it in a CodecChain partial decoder.

fn default_name(&self) -> String

The default name of the codec.

fn configuration(&self, name: &str) -> Option<Configuration>

Create the codec configuration with default options.

impl Debug for ZstdCodec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.