Struct MaintainedCandidateStateProvider 

pub struct MaintainedCandidateStateProvider { /* private fields */ }

First-party provider maintaining named graph-derived candidate sets.

Implementations

impl MaintainedCandidateStateProvider

pub fn new( specs: impl IntoIterator<Item = CandidateStateSpec>, ) -> Result<Self, ProviderError>

Construct an empty provider for specs.

Errors

Returns ProviderError when two specs use the same name.

pub fn from_graph( specs: impl IntoIterator<Item = CandidateStateSpec>, graph: &SeleneGraph, ) -> Result<Self, ProviderError>

Construct a provider and initialize it from a graph snapshot.

Errors

Returns ProviderError when specs are invalid or the graph snapshot is internally inconsistent.

pub fn rebuild_from_graph( &self, graph: &SeleneGraph, ) -> Result<(), ProviderError>

Rebuild all maintained state from graph.

This is the safe attachment path when a provider is registered against an already-populated graph instead of observing mutations from graph birth.

Errors

Returns ProviderError if live row-to-id mappings are inconsistent.

pub fn spec(&self, name: &DbString) -> Option<&CandidateStateSpec>

Return the configured spec named name.

pub fn candidate_set(&self, name: &DbString) -> Option<VectorCandidateSet>

Return the current candidate set for name.

pub fn generation(&self) -> u64

Return the provider generation watermark.

pub fn candidate_set_at_generation( &self, name: &DbString, generation: u64, ) -> Result<Option<VectorCandidateSet>, ProviderError>

Return the current candidate set for name if it matches generation.

Errors

Returns ProviderError when this provider has not applied every mutation through generation.

pub fn candidate_state_infos_at_generation( &self, generation: u64, ) -> Result<Vec<VectorCandidateStateInfo>, ProviderError>

Return generation-checked metadata for every configured candidate set.

Errors

Returns ProviderError when this provider has not applied every mutation through generation.

pub fn contains(&self, name: &DbString, node: NodeId) -> bool

Return true when node is currently a member of the named set.

Trait Implementations

impl IndexProvider for MaintainedCandidateStateProvider

fn provider_tag(&self) -> ProviderTag

Stable 4-byte ASCII tag uniquely identifying this provider.

fn read_section( &self, sub_tag: SubTag, bytes: &[u8], ) -> Result<(), ProviderError>

Snapshot bootstrap for one provider-owned section.

fn write_section(&self, sub_tag: SubTag) -> Result<Vec<u8>, ProviderError>

Snapshot publish for one provider-owned section.

fn on_change(&self, change: &Change) -> Result<(), ProviderError>

Observe one committed mutation.

fn handles_change_batches(&self) -> bool

Return true when this provider wants one callback per committed change batch.

fn on_changes(&self, changes: &[Change]) -> Result<(), ProviderError>

Observe all changes from one committed mutation batch.

fn rebuild_from_graph(&self, graph: &SeleneGraph) -> Result<(), ProviderError>

Rebuild provider-owned derived state from a recovered graph snapshot.

fn on_commit_applied(&self, generation: u64) -> Result<(), ProviderError>

Observe that every change for a committed graph generation was applied.

fn vector_candidate_set( &self, name: &DbString, generation: u64, ) -> Result<Option<VectorCandidateSet>, ProviderError>

Return a provider-owned vector candidate set for name at generation.

fn vector_candidate_state_infos( &self, generation: u64, ) -> Result<Vec<VectorCandidateStateInfo>, ProviderError>

Return provider-owned vector candidate-state descriptors at generation.

fn declared_sub_tags(&self) -> &[SubTag]

Provider-owned snapshot subsection tags.