Struct ZlibCodec 

pub struct ZlibCodec { /* private fields */ }

Available on crate feature zlib only.

A zlib codec implementation.

Implementations

impl ZlibCodec

pub fn new(level: ZlibCompressionLevel) -> Self

Create a new zlib codec.

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

Create a new zlib codec from configuration.

Errors

Returns an error if the configuration is not supported.

Trait Implementations

impl BytesToBytesCodecTraits for ZlibCodec

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: ArrayBytesRaw<'a>, _options: &CodecOptions, ) -> Result<ArrayBytesRaw<'a>, CodecError>

Encode chunk bytes.

fn decode<'a>( &self, encoded_value: ArrayBytesRaw<'a>, _decoded_representation: &BytesRepresentation, _options: &CodecOptions, ) -> Result<ArrayBytesRaw<'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 with_codec_specific_options( self: Arc<Self>, opts: &CodecSpecificOptions, ) -> Arc<dyn BytesToBytesCodecTraits>

Return a version of this codec reconfigured with the provided codec-specific options.

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_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 'life0: 'async_trait, 'life1: 'async_trait, Self: Sync + Send + '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_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 'life0: 'async_trait, 'life1: 'async_trait, Self: Sync + Send + 'async_trait,

Available on crate feature async only.

Initialise an asynchronous partial encoder.

impl Clone for ZlibCodec

fn clone(&self) -> ZlibCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodecTraits for ZlibCodec

fn as_any(&self) -> &dyn Any

Returns this codec as Any.

fn configuration( &self, _version: ZarrVersion, _options: &CodecMetadataOptions, ) -> Option<Configuration>

Create the codec configuration.

fn partial_decoder_capability(&self) -> PartialDecoderCapability

Returns the partial decoder capability of this codec.

fn partial_encoder_capability(&self) -> PartialEncoderCapability

Returns the partial encoder capability of this codec.

fn configuration_v3( &self, options: &CodecMetadataOptions, ) -> Option<Configuration>

Create the Zarr V3 codec configuration.

fn configuration_v2( &self, options: &CodecMetadataOptions, ) -> Option<Configuration>

Create the Zarr V2 codec configuration.

impl CodecTraitsV2 for ZlibCodec

fn create(metadata: &MetadataV2) -> Result<Codec, PluginCreateError>

Create a codec from Zarr V2 metadata.

impl CodecTraitsV3 for ZlibCodec

fn create(metadata: &MetadataV3) -> Result<Codec, PluginCreateError>

Create a codec from Zarr V3 metadata.

impl Debug for ZlibCodec

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

Formats the value using the given formatter.

impl ExtensionAliases<ZarrVersion2> for ZlibCodec

fn aliases() -> RwLockReadGuard<'static, ExtensionAliasesConfig>

Get a read lock on the aliases configuration for this version.

fn aliases_mut() -> RwLockWriteGuard<'static, ExtensionAliasesConfig>

Get a write lock on the aliases configuration for this version.

fn matches_name(name: &str) -> bool

Check if the given name matches this extension’s identifier or any of its aliases for the given Zarr version.

impl ExtensionAliases<ZarrVersion3> for ZlibCodec

fn aliases() -> RwLockReadGuard<'static, ExtensionAliasesConfig>

Get a read lock on the aliases configuration for this version.

fn aliases_mut() -> RwLockWriteGuard<'static, ExtensionAliasesConfig>

Get a write lock on the aliases configuration for this version.

fn matches_name(name: &str) -> bool

Check if the given name matches this extension’s identifier or any of its aliases for the given Zarr version.

impl ExtensionNameStatic for ZlibCodec

const DEFAULT_NAME_FN: fn(ZarrVersion) -> Option<Cow<'static, str>>

Function pointer to get the default name for a given Zarr version.