Trait zarrs::array::codec::CodecTraits

source ·

pub trait CodecTraits: Send + Sync {
    // Required methods
    fn create_metadata_opt(
        &self,
        options: &ArrayMetadataOptions
    ) -> Option<Metadata>;
    fn partial_decoder_should_cache_input(&self) -> bool;
    fn partial_decoder_decodes_all(&self) -> bool;

    // Provided method
    fn create_metadata(&self) -> Option<Metadata> { ... }
}

Expand description

Codec traits.

Required Methods§

source

fn create_metadata_opt( &self, options: &ArrayMetadataOptions ) -> Option<Metadata>

Create metadata.

A hidden codec (e.g. a cache) will return None, since it will not have any associated metadata.

source

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.

source

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.