Struct IndexedMap 

pub struct IndexedMap<'a, S: IndexedStore> { /* private fields */ }

Implementations

impl<S: IndexedStore> IndexedMap<'_, S>

pub fn export_current(&self) -> Result<IndexedSnapshotBundle, Error>

pub fn export_current_with_budget( &self, budget: &TransferBudget, ) -> Result<IndexedSnapshotBundle, Error>

pub fn import_current( &self, bundle: &IndexedSnapshotBundle, expected_source: Option<&MapVersionId>, ) -> Result<IndexedVersion, Error>

pub fn import_current_with_budget( &self, bundle: &IndexedSnapshotBundle, expected_source: Option<&MapVersionId>, budget: &TransferBudget, ) -> Result<IndexedVersion, Error>

impl<'a, S: IndexedStore> IndexedMap<'a, S>

pub fn id(&self) -> &[u8]

pub fn registry(&self) -> &SecondaryIndexRegistry

pub fn store_profile(&self) -> IndexedStoreProfile

pub fn source(&self) -> IndexedSourceView<'_, 'a, S>

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

pub fn get_with<R>( &self, key: &[u8], read: impl FnOnce(&[u8]) -> R, ) -> Result<Option<R>, Error>

pub fn health(&self) -> Result<IndexedMapHealth, Error>

pub fn metrics(&self) -> IndexedMapMetricsSnapshot

pub fn ensure_index( &self, name: impl AsRef<[u8]>, ) -> Result<IndexBuildResult, Error>

pub fn ensure_index_with_budget( &self, name: impl AsRef<[u8]>, budget: &MaintenanceBudget, ) -> Result<IndexBuildResult, Error>

pub fn apply(&self, mutations: Vec<Mutation>) -> Result<IndexedVersion, Error>

pub fn apply_with_budget( &self, mutations: Vec<Mutation>, budget: &MutationBudget, ) -> Result<IndexedVersion, Error>

pub fn apply_if( &self, expected: Option<&MapVersionId>, mutations: Vec<Mutation>, ) -> Result<IndexedMapUpdate, Error>

pub fn put( &self, key: impl Into<Vec<u8>>, value: impl Into<Vec<u8>>, ) -> Result<IndexedVersion, Error>

pub fn delete(&self, key: impl Into<Vec<u8>>) -> Result<IndexedVersion, Error>

pub fn edit( &self, edit: impl FnOnce(&mut IndexedMapEditor), ) -> Result<IndexedVersion, Error>

pub fn verify_index( &self, name: impl AsRef<[u8]>, source_version: &MapVersionId, ) -> Result<IndexVerification, Error>

pub fn verify_index_with_budget( &self, name: impl AsRef<[u8]>, source_version: &MapVersionId, budget: &MaintenanceBudget, ) -> Result<IndexVerification, Error>

pub fn verify_all( &self, source_version: &MapVersionId, ) -> Result<Vec<IndexVerification>, Error>

pub fn verify_all_with_budget( &self, source_version: &MapVersionId, budget: &MaintenanceBudget, ) -> Result<Vec<IndexVerification>, Error>

pub fn repair_index( &self, name: impl AsRef<[u8]>, source_version: &MapVersionId, ) -> Result<IndexVerification, Error>

pub fn repair_index_with_budget( &self, name: impl AsRef<[u8]>, source_version: &MapVersionId, budget: &MaintenanceBudget, ) -> Result<IndexVerification, Error>

pub fn replace_index( &self, name: impl AsRef<[u8]>, new_definition: SecondaryIndex, ) -> Result<IndexBuildResult, Error>

pub fn deactivate_index( &self, name: impl AsRef<[u8]>, ) -> Result<IndexedVersion, Error>

pub fn pin_snapshot<'map>( &'map self, pin_id: impl AsRef<[u8]>, source_version: &MapVersionId, ) -> Result<SnapshotPinGuard<'map, 'a, S>, Error>

pub fn retain_snapshot_pin( &self, pin_id: impl AsRef<[u8]>, source_version: &MapVersionId, ) -> Result<(), Error>

pub fn release_snapshot_pin( &self, pin_id: impl AsRef<[u8]>, ) -> Result<(), Error>

pub fn keep_last(&self, count: usize) -> Result<IndexedRetentionResult, Error>

impl<S> IndexedMap<'_, S>

where S: IndexedStore + NodeStoreScan + ManifestStoreScan,

pub fn plan_indexed_gc(&self) -> Result<GcPlan, Error>

pub fn sweep_indexed_gc( &self, explicit_quiescence: bool, ) -> Result<GcSweep, Error>

impl<'a, S> IndexedMap<'a, S>

where S: IndexedStore,

pub fn snapshot(&self) -> Result<IndexedSnapshot<'a, S>, Error>

Pin one canonical collection-state root and all immutable trees it names.

pub fn snapshot_at( &self, source_version: &MapVersionId, ) -> Result<IndexedSnapshot<'a, S>, Error>

Reopen the retained canonical snapshot containing this source tree.

pub fn snapshot_by_id( &self, id: &IndexedSnapshotId, ) -> Result<IndexedSnapshot<'a, S>, Error>

Reopen the exact retained content-addressed snapshot represented by id.