Struct BytesCodec 

pub struct BytesCodec { /* private fields */ }

A bytes codec implementation.

Implementations

impl BytesCodec

pub const fn new(endian: Option<Endianness>) -> Self

Create a new bytes codec.

endian is optional because an 8-bit type has no endianness.

pub const fn little() -> Self

Create a new bytes codec for little endian data.

pub const fn big() -> Self

Create a new bytes codec for big endian data.

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

Create a new bytes codec from configuration.

Errors

Returns an error if the configuration is not supported.

Trait Implementations

impl ArrayCodecTraits for BytesCodec

fn recommended_concurrency( &self, _shape: &[NonZeroU64], _data_type: &DataType, ) -> Result<RecommendedConcurrency, CodecError>

Return the recommended concurrency for the requested decoded representation.

fn partial_decode_granularity( &self, shape: &[NonZero<u64>], ) -> Vec<NonZero<u64>>

Return the partial decode granularity.

impl ArrayToBytesCodecTraits for BytesCodec

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

Return a dynamic version of the codec.

fn encode<'a>( &self, bytes: ArrayBytes<'a>, shape: &[NonZeroU64], data_type: &DataType, _fill_value: &FillValue, _options: &CodecOptions, ) -> Result<ArrayBytesRaw<'a>, CodecError>

Encode a chunk.

fn decode<'a>( &self, bytes: ArrayBytesRaw<'a>, shape: &[NonZeroU64], data_type: &DataType, _fill_value: &FillValue, _options: &CodecOptions, ) -> Result<ArrayBytes<'a>, CodecError>

Decode a chunk.

fn partial_decoder( self: Arc<Self>, input_handle: Arc<dyn BytesPartialDecoderTraits>, shape: &[NonZeroU64], data_type: &DataType, fill_value: &FillValue, _options: &CodecOptions, ) -> Result<Arc<dyn ArrayPartialDecoderTraits>, CodecError>

Initialise a partial decoder.

fn partial_encoder( self: Arc<Self>, input_output_handle: Arc<dyn BytesPartialEncoderTraits>, shape: &[NonZeroU64], data_type: &DataType, fill_value: &FillValue, _options: &CodecOptions, ) -> Result<Arc<dyn ArrayPartialEncoderTraits>, CodecError>

Initialise a partial encoder.

fn async_partial_decoder<'life0, 'life1, 'life2, 'life3, 'async_trait>( self: Arc<Self>, input_handle: Arc<dyn AsyncBytesPartialDecoderTraits>, shape: &'life0 [NonZeroU64], data_type: &'life1 DataType, fill_value: &'life2 FillValue, _options: &'life3 CodecOptions, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn AsyncArrayPartialDecoderTraits>, CodecError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Available on crate feature async only.

Initialise an asynchronous partial decoder.

fn async_partial_encoder<'life0, 'life1, 'life2, 'life3, 'async_trait>( self: Arc<Self>, input_output_handle: Arc<dyn AsyncBytesPartialEncoderTraits>, shape: &'life0 [NonZeroU64], data_type: &'life1 DataType, fill_value: &'life2 FillValue, _options: &'life3 CodecOptions, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn AsyncArrayPartialEncoderTraits>, CodecError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Available on crate feature async only.

Initialise an asynchronous partial encoder.

fn encoded_representation( &self, shape: &[NonZeroU64], data_type: &DataType, _fill_value: &FillValue, ) -> Result<BytesRepresentation, CodecError>

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

fn compact<'a>( &self, bytes: Cow<'a, [u8]>, shape: &[NonZero<u64>], data_type: &DataType, fill_value: &FillValue, options: &CodecOptions, ) -> Result<Option<Cow<'a, [u8]>>, CodecError>

Compact a chunk.

fn decode_into( &self, bytes: Cow<'_, [u8]>, shape: &[NonZero<u64>], data_type: &DataType, fill_value: &FillValue, output_target: ArrayBytesDecodeIntoTarget<'_>, options: &CodecOptions, ) -> Result<(), CodecError>

Decode into a subset of a preallocated output.

impl Clone for BytesCodec

fn clone(&self) -> BytesCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodecTraits for BytesCodec

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 CodecTraitsV3 for BytesCodec

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

Create a codec from Zarr V3 metadata.

impl Debug for BytesCodec

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

Formats the value using the given formatter.

impl Default for BytesCodec

fn default() -> Self

Returns the “default value” for a type.

impl ExtensionAliases<ZarrVersion2> for BytesCodec

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 BytesCodec

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 BytesCodec

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

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