Struct MapSnapshot 

pub struct MapSnapshot<'a, S: Store> { /* private fields */ }

An immutable, version-pinned view over one managed map snapshot.

A snapshot owns its MapVersion handle and borrows the engine. All reads stay on that tree even when another writer advances the managed map’s head. This is the preferred surface for request-scoped reads, long scans, proofs, export, and diagnostics.

Implementations

impl<'a, S: Store> MapSnapshot<'a, S>

pub fn version(&self) -> &MapVersion

Metadata and tree handle for this pinned version.

pub fn id(&self) -> &MapVersionId

Stable content-derived identifier for this pinned version.

pub fn tree(&self) -> &Tree

Immutable tree handle used by this snapshot.

pub fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Error>

Read one key.

pub fn get_value_ref(&self, key: &[u8]) -> Result<Option<ValueRef>, Error>

Read the stored inline/blob reference without resolving blob bytes.

pub fn get_large_value<B: BlobStore>( &self, blob_store: &B, key: &[u8], ) -> Result<Option<Vec<u8>>, Error>

Read one value and resolve offloaded blob content when necessary.

pub fn contains_key(&self, key: &[u8]) -> Result<bool, Error>

Check whether one key exists.

pub fn get_many<K: AsRef<[u8]>>( &self, keys: &[K], ) -> Result<Vec<Option<Vec<u8>>>, Error>

Read several keys while preserving caller order and duplicates.

pub fn first_entry(&self) -> Result<Option<KeyValue>, Error>

Return the first entry in key order.

pub fn last_entry(&self) -> Result<Option<KeyValue>, Error>

Return the last entry in key order.

pub fn lower_bound(&self, key: &[u8]) -> Result<Option<KeyValue>, Error>

Return the first entry whose key is greater than or equal to key.

pub fn upper_bound(&self, key: &[u8]) -> Result<Option<KeyValue>, Error>

Return the first entry whose key is strictly greater than key.

pub fn range<'s>( &'s self, start: &[u8], end: Option<&[u8]>, ) -> Result<RangeIter<'s, S>, Error>

Lazily stream a half-open key range from this immutable snapshot.

pub fn stream_range<'s>( &'s self, start: &[u8], end: Option<&[u8]>, ) -> Result<RangeIter<'s, S>, Error>

Explicit alias for MapSnapshot::range emphasizing lazy large scans.

pub fn prefix<'s>(&'s self, prefix: &[u8]) -> Result<RangeIter<'s, S>, Error>

Lazily stream every entry under prefix.

pub fn stream_prefix<'s>( &'s self, prefix: &[u8], ) -> Result<RangeIter<'s, S>, Error>

Explicit alias for MapSnapshot::prefix emphasizing lazy large scans.

pub fn range_page( &self, cursor: &RangeCursor, end: Option<&[u8]>, limit: usize, ) -> Result<RangePage, Error>

Read one forward cursor page.

pub fn prefix_page( &self, prefix: &[u8], cursor: &RangeCursor, limit: usize, ) -> Result<RangePage, Error>

Read one prefix-bounded forward cursor page.

pub fn reverse_page( &self, cursor: &ReverseCursor, start: &[u8], limit: usize, ) -> Result<ReversePage, Error>

Read one reverse cursor page from the end of [start, +inf).

pub fn prefix_reverse_page( &self, prefix: &[u8], cursor: &ReverseCursor, limit: usize, ) -> Result<ReversePage, Error>

Read one reverse cursor page inside prefix.

pub fn reverse_scan( &self, start: &[u8], page_size: usize, ) -> MapReverseIter<'a, S>

Lazily scan [start, +inf) in descending key order.

page_size bounds each internal store traversal and is clamped to one.

pub fn prefix_reverse_scan( &self, prefix: &[u8], page_size: usize, ) -> MapReverseIter<'a, S>

Lazily scan one prefix in descending key order.

pub fn cursor_window( &self, key: &[u8], end: Option<&[u8]>, limit: usize, ) -> Result<CursorWindow, Error>

Seek to key and return a bounded forward window.

pub fn stats(&self) -> Result<TreeStats, Error>

Collect structural and serialized-size statistics for this snapshot.

pub fn debug_view(&self) -> Result<TreeDebugView, Error>

Return a deterministic diagnostic view grouped by tree level.

pub fn prove_key(&self, key: &[u8]) -> Result<KeyProof, Error>

Build a self-contained proof of one key’s presence or absence.

pub fn prove_keys<K: AsRef<[u8]>>( &self, keys: &[K], ) -> Result<MultiKeyProof, Error>

Build one shared proof for several keys.

pub fn prove_range( &self, start: &[u8], end: Option<&[u8]>, ) -> Result<RangeProof, Error>

Build a complete proof for [start, end).

pub fn prove_prefix(&self, prefix: &[u8]) -> Result<RangeProof, Error>

Build a complete proof for all entries under prefix.

pub fn prove_range_page( &self, cursor: &RangeCursor, end: Option<&[u8]>, limit: usize, ) -> Result<ProvedRangePage, Error>

Read and prove one cursor page.

pub fn authenticate_proof_bundle( &self, proof_bundle: impl Into<Vec<u8>>, secret: &[u8], authentication: ProofAuthentication, ) -> Result<AuthenticatedProofEnvelope, Error>

Authenticate canonical proof bundle bytes with HMAC-SHA256.

pub fn export(&self) -> Result<SnapshotBundle, Error>

Export this tree and every reachable node as a portable verified bundle.

pub fn plan_missing_nodes<D: Store>( &self, destination: &D, ) -> Result<MissingNodePlan, Error>

Plan which nodes another store is missing for this snapshot.

pub fn copy_missing_nodes<D: Store>( &self, destination: &D, ) -> Result<MissingNodeCopy, Error>

Copy this snapshot’s missing nodes into another store.

pub fn push_to<D>( &self, destination: &VersionedMap<'_, D>, ) -> Result<MapVersion, Error>

where D: Store + ManifestStore + TransactionalStore,

Copy and publish this snapshot as the head of another managed map.

pub fn pin_root(&self) -> Result<usize, Error>

Pin this snapshot’s root in the engine cache.

pub fn pin_path(&self, key: &[u8]) -> Result<usize, Error>

Pin the root-to-leaf path for one hot key or prefix.

pub fn publish_prefix_hint(&self, prefix: &[u8]) -> Result<bool, Error>

Persist a correctness-optional hot-prefix path hint.

pub fn hydrate_prefix_hint(&self, prefix: &[u8]) -> Result<bool, Error>

Hydrate the engine cache from a previously published prefix hint.