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 const fn new_with_configuration( configuration: &BytesCodecConfiguration, ) -> Self

Create a new bytes codec from configuration.

Trait Implementations

impl ArrayCodecTraits for BytesCodec

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

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

Return a dynamic version of the codec.

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

Encode a chunk.

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

Decode a chunk.

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

Initialise a partial decoder.

fn partial_encoder( self: Arc<Self>, input_handle: Arc<dyn BytesPartialDecoderTraits>, output_handle: Arc<dyn BytesPartialEncoderTraits>, 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 AsyncBytesPartialDecoderTraits>, 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 compute_encoded_size( &self, decoded_representation: &ChunkRepresentation, ) -> Result<BytesRepresentation, CodecError>

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

unsafe fn decode_into( &self, bytes: RawBytes<'_>, decoded_representation: &ChunkRepresentation, output: &UnsafeCellSlice<'_, u8>, output_shape: &[u64], output_subset: &ArraySubset, options: &CodecOptions, ) -> Result<(), CodecError>

Decode into a subset of a preallocated output.

impl Clone for BytesCodec

fn clone(&self) -> BytesCodec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CodecTraits for BytesCodec

fn create_metadata_opt( &self, _options: &ArrayMetadataOptions, ) -> Option<MetadataV3>

Create metadata.

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 create_metadata(&self) -> Option<MetadataV3>

Create metadata with default options.

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.