Struct BitroundCodec 

pub struct BitroundCodec { /* private fields */ }

Available on crate feature bitround only.

A bitround codec implementation.

Implementations

impl BitroundCodec

pub const fn new(keepbits: u32) -> Self

Create a new bitround codec.

keepbits is the number of bits to round to in the floating point mantissa.

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

Create a new bitround codec from a configuration.

Errors

Returns an error if the configuration is not supported.

Trait Implementations

impl ArrayCodecTraits for BitroundCodec

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

Return the recommended concurrency for the requested decoded representation.

fn partial_decode_granularity( &self, decoded_representation: &ChunkRepresentation, ) -> ChunkShape

Return the partial decode granularity.

impl ArrayToArrayCodecTraits for BitroundCodec

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

Return a dynamic version of the codec.

fn encode<'a>( &self, bytes: ArrayBytes<'a>, decoded_representation: &ChunkRepresentation, _options: &CodecOptions, ) -> Result<ArrayBytes<'a>, CodecError>

Encode a chunk.

fn decode<'a>( &self, bytes: ArrayBytes<'a>, _decoded_representation: &ChunkRepresentation, _options: &CodecOptions, ) -> Result<ArrayBytes<'a>, CodecError>

Decode a chunk.

fn partial_decoder( self: Arc<Self>, input_handle: Arc<dyn ArrayPartialDecoderTraits>, decoded_representation: &ChunkRepresentation, _options: &CodecOptions, ) -> Result<Arc<dyn ArrayPartialDecoderTraits>, CodecError>

Initialise a partial decoder.

fn partial_encoder( self: Arc<Self>, input_output_handle: Arc<dyn ArrayPartialEncoderTraits>, decoded_representation: &ChunkRepresentation, _options: &CodecOptions, ) -> Result<Arc<dyn ArrayPartialEncoderTraits>, CodecError>

Initialise a partial encoder.

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

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

Available on crate feature async only.

Initialise an asynchronous partial decoder.

fn async_partial_encoder<'life0, 'life1, 'async_trait>( self: Arc<Self>, input_output_handle: Arc<dyn AsyncArrayPartialEncoderTraits>, decoded_representation: &'life0 ChunkRepresentation, _options: &'life1 CodecOptions, ) -> Pin<Box<dyn Future<Output = Result<Arc<dyn AsyncArrayPartialEncoderTraits>, CodecError>> + Send + 'async_trait>>

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

Available on crate feature async only.

Initialise an asynchronous partial encoder.

fn encoded_data_type( &self, decoded_data_type: &DataType, ) -> Result<DataType, CodecError>

Returns the encoded data type for a given decoded data type.

fn encoded_fill_value( &self, decoded_data_type: &DataType, decoded_fill_value: &FillValue, ) -> Result<FillValue, CodecError>

Returns the encoded fill value for a given decoded fill value

fn encoded_shape( &self, decoded_shape: &[NonZeroU64], ) -> Result<ChunkShape, CodecError>

Returns the shape of the encoded chunk for a given decoded chunk shape.

fn decoded_shape( &self, encoded_shape: &[NonZeroU64], ) -> Result<Option<ChunkShape>, CodecError>

Returns the shape of the decoded chunk for a given encoded chunk shape.

fn encoded_representation( &self, decoded_representation: &ChunkRepresentation, ) -> Result<ChunkRepresentation, CodecError>

Returns the encoded chunk representation given the decoded chunk representation.

impl Clone for BitroundCodec

fn clone(&self) -> BitroundCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CodecTraits for BitroundCodec

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_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 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 BitroundCodec

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

Formats the value using the given formatter.

impl Default for BitroundCodec

fn default() -> BitroundCodec

Returns the “default value” for a type.