Struct zarrs::config::Config

pub struct Config { /* private fields */ }

Global configuration options for the zarrs crate.

Retrieve the global Config with global_config and modify it with global_config_mut.

Validate Checksums

default: true

CodecOptions::validate_checksums() defaults to Config::validate_checksums().

If validate checksums is enabled, checksum codecs (e.g. crc32c) will validate that encoded data matches stored checksums, otherwise validation is skipped. Note that regardless of this configuration option, checksum codecs may skip validation when partial decoding.

Store Empty Chunks

default: false

CodecOptions::store_empty_chunks() defaults to Config::store_empty_chunks().

If false, empty chunks (where all elements match the fill value) will not be stored. This incurs a computational overhead as each element must be tested for equality to the fill value before a chunk is encoded. If true, the aforementioned test is skipped and all chunks are stored.

Codec Concurrent Target

default: std::thread::available_parallelism()

CodecOptions::concurrent_target() defaults to Config::codec_concurrent_target().

The default number of concurrent operations to target for codec encoding and decoding. Limiting concurrent operations is needed to reduce memory usage and improve performance. Concurrency is unconstrained if the concurrent target if set to zero.

Note that the default codec concurrent target can be overridden for any encode/decode operation. This is performed automatically for many array operations (see the chunk concurrent minimum option).

Chunk Concurrent Minimum

default: 4

For array operations involving multiple chunks, this is the preferred minimum chunk concurrency. For example, array_store_chunks will concurrently encode and store up to four chunks at a time by default. The concurrency of internal codecs is adjusted to accomodate for the chunk concurrency in accordance with the concurrent target set in the CodecOptions parameter of an encode or decode method.

Experimental Codec Store Metadata If Encode Only

default: false

Some codecs perform potentially irreversible transformations during encoding that decoders do not need to be aware of. If this option is false, experimental codecs with this behaviour will not write their metadata. This enables arrays to be consumed by other zarr3 implementations that do not support the experimental codec. Currently, this options only affects the bitround codec.

Implementations

impl Config

pub fn validate_checksums(&self) -> bool

Get the validate checksums configuration.

pub fn set_validate_checksums(&mut self, validate_checksums: bool)

Set the validate checksums configuration.

pub fn store_empty_chunks(&self) -> bool

Get the store empty chunks configuration.

pub fn set_store_empty_chunks(&mut self, store_empty_chunks: bool)

Set the store empty chunks configuration.

pub fn codec_concurrent_target(&self) -> usize

Get the codec concurrent target configuration.

pub fn set_codec_concurrent_target(&mut self, concurrent_target: usize)

Set the codec concurrent target configuration.

pub fn chunk_concurrent_minimum(&self) -> usize

Get the chunk concurrent minimum configuration.

pub fn set_chunk_concurrent_minimum(&mut self, concurrent_minimum: usize)

Set the chunk concurrent minimum configuration.

pub fn experimental_codec_store_metadata_if_encode_only(&self) -> bool

Get the experimental codec store metadata if encode only configuration.

pub fn set_experimental_codec_store_metadata_if_encode_only( &mut self, enabled: bool )

Set the experimental codec store metadata if encode only configuration.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.