Struct VarTypedMap 

pub struct VarTypedMap<K: Key + Send + Sync + Hash + Eq, T: Send + Sync, C: Codec<T> + Clone, H: TypedWriteHook<K, T> = NoHook> { /* private fields */ }

A map with fixed-size keys and typed values T. Values are encoded via a Codec and stored on disk (variable length), with a BlockCache for reads. Uses per-shard HashMap for O(1) lookup. No ordered iteration — use VarTypedTree if you need prefix/range scans.

Thin wrapper around VarMap<K, VarTypedHookAdapter<K, T, C, H>>.

Error handling

Same convention as VarTypedTree: get returns None on decode errors. migrate keeps entries that fail to decode.

Implementations

impl<K: Key + Send + Sync + Hash + Eq, T: Send + Sync, C: Codec<T> + Clone> VarTypedMap<K, T, C>

pub fn open(path: impl AsRef<Path>, config: Config, codec: C) -> DbResult<Self>

Open or create a VarTypedMap at the given path.

impl<K: Key + Send + Sync + Hash + Eq, T: Send + Sync, C: Codec<T> + Clone, H: TypedWriteHook<K, T>> VarTypedMap<K, T, C, H>

pub fn open_hooked( path: impl AsRef<Path>, config: Config, codec: C, hook: H, ) -> DbResult<Self>

Open or create a VarTypedMap with a typed write hook.

pub fn close(self) -> DbResult<()>

Graceful shutdown: write hint files (if enabled), flush write buffers + fsync.

pub fn flush_buffers(&self) -> DbResult<()>

Flush all shard write buffers to disk (without fsync).

pub fn config(&self) -> &Config

Get the database configuration.

pub fn compact(&self) -> DbResult<usize>

Trigger a compaction pass across all shards.

pub fn sync_hints(&self) -> DbResult<()>

Write hint files for all active shard files. Call during graceful shutdown.

pub fn warmup(&self) -> DbResult<()>

Pre-populate the block cache with blocks containing live values.

pub fn as_inner(&self) -> &VarMap<K, VarTypedHookAdapter<K, T, C, H>>

Access the underlying VarMap.

pub fn codec(&self) -> &C

Access the codec used for encoding / decoding values.

pub fn get(&self, key: &K) -> Option<T>

pub fn get_or_err(&self, key: &K) -> DbResult<T>

pub fn contains(&self, key: &K) -> bool

pub fn put(&self, key: &K, value: &T) -> DbResult<()>

pub fn insert(&self, key: &K, value: &T) -> DbResult<()>

pub fn delete(&self, key: &K) -> DbResult<bool>

pub fn cas(&self, key: &K, expected: &T, new_value: &T) -> DbResult<()>

pub fn update(&self, key: &K, f: impl FnOnce(&T) -> T) -> DbResult<Option<T>>

pub fn fetch_update( &self, key: &K, f: impl FnOnce(&T) -> T, ) -> DbResult<Option<T>>

pub fn atomic<R>( &self, shard_key: &K, f: impl FnOnce(&mut VarTypedMapShard<'_, K, T, C, H>) -> DbResult<R>, ) -> DbResult<R>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn shard_for(&self, key: &K) -> usize

pub fn entry_len(&self, key: &K) -> Option<u32>

Encoded value byte length for key, or None if absent. Reads only the in-memory index entry (DiskLoc::len); no disk I/O.

pub fn migrate(&self, f: impl Fn(&K, &T) -> MigrateAction<T>) -> DbResult<usize>

Trait Implementations

impl<T, C, H> Collection for VarTypedMap<T::SelfId, T, C, H>

where T: CollectionMeta + Send + Sync, C: Codec<T> + Clone + 'static, H: TypedWriteHook<T::SelfId, T>, T::SelfId: Key + Send + Sync + Hash + Eq,

Available on crate feature armour only.

fn name(&self) -> &str

Collection name (from CollectionMeta::NAME).

fn len(&self) -> usize

Number of entries in the collection.

fn compact(&self) -> DbResult<usize>

Run a compaction pass across all shards.

fn flush(&self) -> DbResult<()>

Flush in-memory write buffers and pending hint data so an immediate process exit will not lose committed writes. No default — every impl must provide this to avoid silent durability gaps.

fn is_empty(&self) -> bool

impl<K: Key + Send + Sync + Hash + Eq, T: Send + Sync, C: Codec<T> + Clone, H: TypedWriteHook<K, T>> CompactionIndex<K> for VarTypedMap<K, T, C, H>

fn update_if_match(&self, key: &K, old_loc: DiskLoc, new_loc: DiskLoc) -> bool

If the current index points to old_loc, it is updated to new_loc and returns true.

fn invalidate_blocks(&self, shard_id: u8, file_id: u32, total_bytes: u64)

Invalidate cached blocks for a file after compaction replaces its contents.

fn contains_key(&self, key: &K) -> bool

Returns true if the key currently exists in the index (i.e. has a live Put).

impl<K: Key + Send + Sync + Hash + Eq, T: Send + Sync, C: Codec<T> + Clone, H: TypedWriteHook<K, T>> ReplicationTarget for VarTypedMap<K, T, C, H>

Available on crate feature replication only.

fn apply_entry( &self, shard_inner: &mut ShardInner, shard_id: u8, file_id: u32, entry_offset: u64, header: &EntryHeader, key: &[u8], value: &[u8], ) -> DbResult<ApplyOutcome>

Apply entry with known key/value split (streaming mode, O(1) routing). Returns the outcome so the registry can account dead bytes.

fn try_apply_entry( &self, shard_inner: &mut ShardInner, shard_id: u8, file_id: u32, entry_offset: u64, header: &EntryHeader, raw_after_header: &[u8], ) -> DbResult<ApplyOutcome>

Try to apply entry with CRC matching (catch-up mode). Returns ApplyOutcome::NotMatched if CRC fails (key belongs to a different target).

fn key_len(&self) -> usize

The key length (K) for this tree type.