Struct BlockStoreConfig 

pub struct BlockStoreConfig {

    pub path: PathBuf,
    pub block_cache_capacity: usize,
    pub header_cache_capacity: usize,
    pub cache_shards: usize,
    pub warm_cache_on_open: bool,
    pub warm_cache_depth: u64,
    pub write_buffer_size: usize,
    pub block_cache_size: usize,
    pub max_open_files: i32,
    pub enable_blob_db: bool,
    pub compress_blocks: bool,
    pub compression_level: i32,
    pub use_compression_dict: bool,
    pub max_decompressed_block_bytes: usize,
    pub zstd_dictionary_override: Option<Vec<u8>>,
    pub write_pipeline_batch_size: usize,
    pub write_pipeline_flush_ms: u64,
    pub write_pipeline_channel_capacity: usize,
    pub sync_writes: bool,
    pub readahead_size: usize,
    pub canonical_height_cache_capacity: usize,
    pub hash_to_height_cache_capacity: usize,
    pub enable_compaction_pruning: bool,
    pub min_retained_height: Option<u64>,
}

Configuration for opening or creating a crate::store::BlockStore.

Construction: Use BlockStoreConfig::default and override fields, std::default::Default::default with struct update syntax (BlockStoreConfig { path: my_dir, ..Default::default() }), or STR-005 test_config for tiny test tunables.

Validation: crate::store::BlockStore::open should eventually enforce cache_shards is a power of two (TYP-008 implementation notes); today callers should follow that invariant.

Fields

path: PathBuf

Root directory for the RocksDB database files (TYP-008 path).

block_cache_capacity: usize

Max blocks retained in the sharded block cache.

header_cache_capacity: usize

Max headers retained in the sharded header cache.

cache_shards: usize

Shard count for block/header caches; must be a power of two when enforced (TYP-008).

warm_cache_on_open: bool

When true, crate::store::BlockStore::open preloads recent canonical blocks (STR-004, CAC-006).

warm_cache_depth: u64

Trailing heights (inclusive) to touch when warming, starting from tip (CAC-006).

write_buffer_size: usize

RocksDB memtable / write buffer budget per column family (bytes).

block_cache_size: usize

Shared block cache for RocksDB (bytes).

max_open_files: i32

max_open_files passed to RocksDB options.

enable_blob_db: bool

When true, enable BlobDB-style large-value handling for block bodies (TYP-003).

compress_blocks: bool

When true, store compressed block payloads (SER-001); tests often disable for simplicity (STR-005).

compression_level: i32

Zstd level for block compression when compress_blocks is true.

use_compression_dict: bool

Whether to use a trained zstd dictionary (SER-005).

max_decompressed_block_bytes: usize

Max accepted decompressed byte length for a stored block body (SER-001).

zstd_dictionary_override: Option<Vec<u8>>

Optional zstd dictionary bytes wired at open time (SER-001).

Production: leave None — crate::store::BlockStore::open loads crate::constants::META_ZSTD_DICT from CF_METADATA when Self::use_compression_dict is true (SER-005). Tests: set to a trained dictionary to exercise dictionary compress/decompress without persisting metadata first.

write_pipeline_batch_size: usize

Max blocks batched before a pipeline flush.

write_pipeline_flush_ms: u64

Max wait before flushing a partial pipeline batch (milliseconds).

write_pipeline_channel_capacity: usize

Bounded async channel capacity feeding the write pipeline (BLK-008).

sync_writes: bool

When true, sync the WAL after each write (durability vs throughput).

readahead_size: usize

Hint for sequential readahead (BLK-006).

canonical_height_cache_capacity: usize

Max entries in the canonical height→hash BTreeMap cache (CAC-004).

When the cache exceeds this size, the lowest height entry is evicted. Set to 0 to disable the height cache entirely.

hash_to_height_cache_capacity: usize

Max entries in the hash→height reverse lookup cache (CAC-005).

Uses the same sharded LRU infrastructure as block/header caches. Higher capacity is practical because each entry is only 40 bytes (32 hash + 8 height).

enable_compaction_pruning: bool

Register compaction-time pruning when true (PRN-003).

min_retained_height: Option<u64>

Optional floor height below which compaction may drop data; None disables.

Trait Implementations

impl Clone for BlockStoreConfig

fn clone(&self) -> BlockStoreConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlockStoreConfig

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

Formats the value using the given formatter.

impl Default for BlockStoreConfig

fn default() -> Self

Returns the “default value” for a type.