Struct SearchCatalog 

pub struct SearchCatalog { /* private fields */ }

A complete, incremental search catalogue keyed by canonical resource id.

Cloning a catalogue is O(1), so a widget can retain one instance and return a cheap provider handle whenever Ctrl+K opens. Mutations are recorded immediately and indexed in one batch before the next query. Queries are paged by both result count and work budget; result objects are cloned only for the hits in the requested page.

Fields are found by folded substring and ranked by the best weighted field match (see [tilo_search]). Bodies (SearchRecord::body) are found after every field hit, and a body source that names locations reports the segment a match is in. A unique item is found directly in a corpus of any size; broad queries continue through SearchCursor pages.

Implementations

impl SearchCatalog

pub fn new(name: impl Into<Arc<str>>) -> SearchCatalog

pub fn detached(&self) -> SearchCatalog

An independent copy of this catalogue at its current generation. A session can extend the copy without the published catalogue — or any other session sharing it — observing the change.

pub fn replace_all( &self, rows: impl IntoIterator<Item = (String, String, SearchResult)>, ) -> Result<(), SearchCatalogError>

Replace an immutable snapshot in one generation. This is the bulk counterpart to Self::upsert: the whole snapshot is indexed in one build, while later incremental updates retain their existing semantics.

Errors

Returns an error for malformed, duplicate, or non-canonical rows, or when catalogue generation/browse identities are exhausted.

pub fn replace_all_records( &self, records: impl IntoIterator<Item = SearchRecord>, ) -> Result<(), SearchCatalogError>

Self::replace_all for weighted records with optional bodies.

Errors

As Self::replace_all.

pub fn sync( &self, rows: impl IntoIterator<Item = (String, String, SearchResult)>, ) -> Result<bool, SearchCatalogError>

Self::sync_records for legacy (resource id, searchable text, result) rows, as Self::replace_all takes them.

Errors

As Self::sync_records.

pub fn sync_records( &self, records: impl IntoIterator<Item = SearchRecord>, ) -> Result<bool, SearchCatalogError>

Make records, in their order, the whole catalogue, as Self::replace_all_records would, indexing only the records that are new, changed or moved, and dropping those absent. Hits and browsing come in the same order a bulk replacement gives. The generation advances once if anything changed and not at all otherwise, so an unchanged snapshot keeps every cursor current.

The catalogue’s write lock is held only to compare and stage the records; indexing them waits for the next query or Self::index_bytes, incrementally when few changed.

Errors

As Self::replace_all_records; the catalogue is then unchanged.

pub fn contains(&self, resource_id: &str) -> bool

Whether a canonical resource is currently retained by this catalogue.

pub fn upsert( &self, resource_id: impl Into<String>, searchable_text: impl AsRef<str>, result: SearchResult, ) -> Result<(), SearchCatalogError>

Insert or replace one durable resource. searchable_text may combine title, metadata and body; result is materialised only when it is a hit on a requested page.

Errors

Returns SearchCatalogError when the stable id is empty, the result is legacy/opaque, or its canonical action addresses another resource.

pub fn upsert_record( &self, record: SearchRecord, ) -> Result<(), SearchCatalogError>

Self::upsert for a weighted record with an optional body.

Errors

As Self::upsert.

pub fn remove(&self, resource_id: &str) -> bool

Remove one resource. Returns whether it existed.

pub fn stats(&self) -> SearchCatalogStats

pub fn index_bytes(&self) -> u64

Bytes the catalogue’s index occupies, once every mutation is indexed.

pub fn cursor_is_current(&self, cursor: &SearchCursor) -> bool

Whether a prior cursor belongs to this exact retained-index generation. The pull directory must turn a mismatch into a stale cursor response, never reinterpret it as an exhausted result set.

pub fn query_page( &self, query: &str, cursor: Option<&SearchCursor>, work_budget: usize, result_limit: usize, ) -> SearchPage

Query one deterministic page. Both budgets are hard ceilings. Continue with the returned cursor when next is set.

Trait Implementations

impl CatalogSearchProvider for SearchCatalog

fn provider_name(&self) -> &str

Group label and diagnostic name, as SearchProvider::name.

fn catalog(&self) -> Option<SearchCatalog>

The catalogue answering queries, or None while none is published (a provider with no catalogue reports no generation and empty pages).

const RESULT_LIMIT: usize = DEFAULT_SEARCH_RESULT_LIMIT

The largest page search and search_limited return. Providers whose palette section shows fewer rows lower it.

fn limited_work_budget(&self, _limit: usize) -> usize

Candidate-inspection budget for a one-shot search_limited(limit) call. The default inspects up to DEFAULT_SEARCH_CANDIDATE_LIMIT candidates to fill limit results; a provider may instead spend no more inspections than results it asked for. query_page caps either at the shared ceiling.

fn catalog_query<'q>(&self, query: &'q str) -> Cow<'q, str>

Rewrite the caller’s query into the form the catalogue was indexed with, for providers that fold their own text before indexing.

fn resolve_action_address(&self, _address: &ActionAddress) -> Option<Resource>

As SearchProvider::resolve_action_resource.

fn facets(&self) -> Vec<Facet>

As SearchProvider::facets.

fn search_scopes(&self) -> Vec<ScopeDecl>

As SearchProvider::search_scopes: the parts of the app this catalogue’s hits can be narrowed to.

fn admits(&self, _hit: &SearchResult, _query: &SearchQuery) -> bool

Whether hit passes query’s facet filters. The catalogue matches text only; a provider with facets checks the hit’s values here (query.admits("language", &[..])). The default admits every hit.

impl Clone for SearchCatalog

fn clone(&self) -> SearchCatalog

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchCatalog

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.