Struct FileConfig 

pub struct FileConfig<C: CompressionCodec> {
    pub codec: C,
    pub block_target_size: usize,
    pub cache_capacity: usize,
    pub io_cache_capacity: usize,
    pub cache: Option<Arc<DeltaCache>>,
}

Configuration for opening or creating an ArrayFile.

Construct with FileConfig::new for the defaults, then override fields as needed:

use array_format::{FileConfig, ZstdCodec};

let config = FileConfig {
    block_target_size: 4 * 1024 * 1024,
    ..FileConfig::new(ZstdCodec { level: 9 })
};

Fields

codec: C

Compression codec applied to data blocks on write.

block_target_size: usize

Target size of a data block before a new block is started, in bytes.

cache_capacity: usize

Byte budget for this file’s decompressed-block cache.

Ignored when cache is Some.

io_cache_capacity: usize

Byte budget for this file’s raw I/O slab cache (0 disables it).

Ignored when cache is Some.

cache: Option<Arc<DeltaCache>>

Optional pre-built cache to share across multiple ArrayFiles.

When Some, cache_capacity and io_cache_capacity are ignored and every file sharing this cache is bounded by one combined byte budget. Entries are keyed by (file_path, block_id), so files do not interfere.

Implementations

impl<C: CompressionCodec> FileConfig<C>

pub fn new(codec: C) -> Self

Creates a config using codec and the DEFAULT_* capacities, with no shared cache.