Struct CoinStoreConfig 

pub struct CoinStoreConfig {
    pub backend: StorageBackend,
    pub storage_path: PathBuf,
    pub max_snapshots: usize,
    pub max_query_results: usize,
    pub lmdb_map_size: usize,
    pub rocksdb_write_buffer_size: usize,
    pub rocksdb_max_open_files: i32,
    pub bloom_filter: bool,
}

Tunable parameters for constructing a crate::coin_store::CoinStore.

Use Default::default for SPEC defaults, then chain with_* to override only what you need. Field semantics follow SPEC §2.6; backend-specific fields apply only when that engine is open (e.g. lmdb_map_size is ignored for RocksDB-only runs).

Requirement: API-003

Spec: docs/requirements/domains/crate_api/specs/API-003.md

Fields

backend: StorageBackend

Storage engine to open (LMDB vs RocksDB).

storage_path: PathBuf

Root directory for database files.

max_snapshots: usize

Retention cap for on-disk state snapshots (future PRF-008).

max_query_results: usize

Upper bound for batch query result size (QRY domain; Chia max_items parity).

lmdb_map_size: usize

LMDB map size (heed / EnvOpenOptions::map_size).

rocksdb_write_buffer_size: usize

RocksDB write_buffer_size (memtable budget per column family group).

rocksdb_max_open_files: i32

RocksDB max_open_files (API-003 / SPEC §2.6 default 1000).

RocksDB engine note: RocksDbBackend in src/storage/rocksdb.rs opens with FIFO compaction on archive_coin_records and state_snapshots (STO-006). The upstream rocksdb crate requires max_open_files = -1 in that configuration, so the backend does not apply this field when opening the DB. The field and Self::with_rocksdb_max_open_files remain for forward compatibility, tests that assert config round-trips, and any alternate layout that drops FIFO.

bloom_filter: bool

When true, RocksDB uses a block-based bloom filter (see BLOOM_FILTER_BITS_PER_KEY).

Implementations

impl CoinStoreConfig

pub fn default_with_path(path: impl AsRef<Path>) -> Self

Defaults with a caller-supplied storage path (the common case for CoinStore::new).

Equivalent to CoinStoreConfig::default() then Self::with_storage_path.

pub fn with_backend(self, backend: StorageBackend) -> Self

Builder: select LMDB vs RocksDB.

pub fn with_storage_path(self, path: impl Into<PathBuf>) -> Self

Builder: filesystem directory for the database.

pub fn with_max_snapshots(self, count: usize) -> Self

Builder: snapshot retention count.

pub fn with_max_query_results(self, count: usize) -> Self

Builder: batch query result ceiling.

pub fn with_lmdb_map_size(self, size: usize) -> Self

Builder: LMDB environment map size in bytes.

pub fn with_rocksdb_write_buffer_size(self, size: usize) -> Self

Builder: RocksDB write buffer size in bytes.

pub fn with_rocksdb_max_open_files(self, count: i32) -> Self

Builder: RocksDB max_open_files (stored on config; see CoinStoreConfig::rocksdb_max_open_files for when it applies).

pub fn with_bloom_filter(self, enabled: bool) -> Self

Builder: enable or disable RocksDB bloom filters (ignored for LMDB).

Trait Implementations

impl Clone for CoinStoreConfig

fn clone(&self) -> CoinStoreConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoinStoreConfig

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

Formats the value using the given formatter.

impl Default for CoinStoreConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CoinStoreConfig

fn eq(&self, other: &CoinStoreConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CoinStoreConfig

impl StructuralPartialEq for CoinStoreConfig