Skip to main content

ProximityMap

Struct ProximityMap 

Source
pub struct ProximityMap<S: Store> { /* private fields */ }
Expand description

Immutable exact-key directory plus deterministic ANN hierarchy.

Implementations§

Source§

impl<S> ProximityMap<S>
where S: Store + Clone + Send + Sync, S::Error: Send + Sync,

Source

pub fn build( store: S, config: ProximityConfig, records: impl IntoIterator<Item = ProximityRecord>, ) -> Result<Self, Error>

Build a canonical proximity map from logical records.

Source

pub fn build_with_parallelism( store: S, config: ProximityConfig, records: impl IntoIterator<Item = ProximityRecord>, parallelism: BuildParallelism, ) -> Result<(Self, ProximityBuildStats), Error>

Build with an explicit runtime worker limit and canonical logical stats.

Source

pub fn load(store: S, descriptor_cid: Cid) -> Result<Self, Error>

Load and locally validate a persisted proximity descriptor.

Source

pub fn tree(&self) -> &ProximityTree

The immutable roots and shape configuration committed by this map.

Source

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

Invalidate process-local decoded proximity objects after an external content sweep. This does not mutate or remove persisted content.

Source

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

Exact key lookup through the authoritative ordered directory.

Source

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

Exact key membership through the authoritative ordered directory.

Source

pub fn rebuild_batch( &self, mutations: impl IntoIterator<Item = ProximityMutation>, ) -> Result<Self, Error>

Canonical full rebuild after applying a sorted-unique logical mutation batch.

Source

pub fn mutate_batch( &self, mutations: impl IntoIterator<Item = ProximityMutation>, ) -> Result<(Self, ProximityMutationStats), Error>

Copy-on-write mutation with exact clean-rebuild CID equivalence.

Source

pub fn search(&self, request: SearchRequest<'_>) -> Result<SearchResult, Error>

Deterministic global best-first search over the authoritative hierarchy.

Source

pub fn verify(&self) -> Result<ProximityVerification, Error>

Traverse and validate the descriptor, directory, hierarchy, and routing invariants.

Source§

impl<S> ProximityMap<S>
where S: Store + Clone + Send + Sync, S::Error: Send + Sync,

Source

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

Prove exact presence or absence without requiring the verifier’s store.

Source§

impl<S> ProximityMap<S>
where S: Store + Clone + Send + Sync, S::Error: Send + Sync,

Prove deterministic native execution. Auto is allowed when it resolves to the native map; explicit accelerator requests use their sidecars.

Source§

impl<S> ProximityMap<S>
where S: Store + Clone + Send + Sync, S::Error: Send + Sync,

Source

pub fn prove_structure( &self, limits: &ContentGraphLimits, ) -> Result<ProximityStructuralProof, Error>

Capture the authenticated typed closure of this immutable snapshot.

Auto Trait Implementations§

§

impl<S> !Freeze for ProximityMap<S>

§

impl<S> RefUnwindSafe for ProximityMap<S>
where S: RefUnwindSafe,

§

impl<S> Send for ProximityMap<S>

§

impl<S> Sync for ProximityMap<S>

§

impl<S> Unpin for ProximityMap<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for ProximityMap<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for ProximityMap<S>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.