Struct CodecSpecificOptions 

pub struct CodecSpecificOptions { /* private fields */ }

Codec-specific options.

This is a type map for codec-specific runtime configuration that is set once and baked into a codec’s state (e.g. when opening or creating an array). It is distinct from CodecOptions, which carries per-operation settings passed at each encode/decode call.

Codecs may define their own options type (e.g. ShardingCodecOptions) and retrieve it via get_option. zarrs_codec itself has no knowledge of any specific codec options type.

Example

#[derive(Debug, Clone, Default)]
pub struct MyCodecOptions {
    pub some_setting: usize,
}

let opts = CodecSpecificOptions::default()
    .with_option(MyCodecOptions { some_setting: 16 });

let retrieved = opts.get_option::<MyCodecOptions>().unwrap();
assert_eq!(retrieved.some_setting, 16);

Implementations

impl CodecSpecificOptions

pub fn with_option<T: Any + Send + Sync>(self, option: T) -> Self

Attach an option for a specific codec, keyed by its type.

If an option of the same type already exists it is replaced.

pub fn get_option<T: Any + Send + Sync>(&self) -> Option<&T>

Retrieve an option by type, returning None if it was not set.

Trait Implementations

impl Clone for CodecSpecificOptions

fn clone(&self) -> CodecSpecificOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecSpecificOptions

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

Formats the value using the given formatter.

impl Default for CodecSpecificOptions

fn default() -> CodecSpecificOptions

Returns the “default value” for a type.