Struct SuggestStore

pub struct SuggestStore { /* private fields */ }

The store is the entry point to the Suggest component. It incrementally downloads suggestions from the Remote Settings service, stores them in a local database, and returns them in response to user queries.

Your application should create a single store, and manage it as a singleton. The store is thread-safe, and supports concurrent queries and ingests. We expect that your application will call SuggestStore::query() to show suggestions as the user types into the address bar, and periodically call SuggestStore::ingest() in the background to update the database with new suggestions from Remote Settings.

For responsiveness, we recommend always calling query() on a worker thread. When the user types new input into the address bar, call SuggestStore::interrupt() on the main thread to cancel the query for the old input, and unblock the worker thread for the new query.

The store keeps track of the state needed to support incremental ingestion, but doesn’t schedule the ingestion work itself, or decide how many suggestions to ingest at once. This is for two reasons:

1. The primitives for scheduling background work vary between platforms, and aren’t available to the lower-level Rust layer. You might use an idle timer on Desktop, WorkManager on Android, or BGTaskScheduler on iOS.
2. Ingestion constraints can change, depending on the platform and the needs of your application. A mobile device on a metered connection might want to request a small subset of the Suggest data and download the rest later, while a desktop on a fast link might download the entire dataset on the first launch.

Implementations

impl SuggestStore

pub fn new( path: &str, remote_settings_service: Arc<RemoteSettingsService>, ) -> Self

Creates a Suggest store.

pub fn query(&self, query: SuggestionQuery) -> SuggestApiResult<Vec<Suggestion>>

Queries the database for suggestions.

pub fn query_with_metrics( &self, query: SuggestionQuery, ) -> SuggestApiResult<QueryWithMetricsResult>

Queries the database for suggestions.

pub fn dismiss_by_suggestion( &self, suggestion: &Suggestion, ) -> SuggestApiResult<()>

Dismiss a suggestion.

Dismissed suggestions cannot be fetched again.

pub fn dismiss_by_key(&self, key: &str) -> SuggestApiResult<()>

Dismiss a suggestion by its dismissal key.

Dismissed suggestions cannot be fetched again.

Prefer SuggestStore::dismiss_by_suggestion if you have a crate::Suggestion. This method is intended for cases where a suggestion originates outside this component.

pub fn dismiss_suggestion(&self, suggestion_url: String) -> SuggestApiResult<()>

Deprecated, use SuggestStore::dismiss_by_suggestion or SuggestStore::dismiss_by_key instead.

Dismiss a suggestion

Dismissed suggestions will not be returned again

pub fn clear_dismissed_suggestions(&self) -> SuggestApiResult<()>

Clear dismissed suggestions

pub fn is_dismissed_by_suggestion( &self, suggestion: &Suggestion, ) -> SuggestApiResult<bool>

Return whether a suggestion has been dismissed.

SuggestStore::query will never return dismissed suggestions, so normally you never need to know whether a Suggestion has been dismissed, but this method can be used to do so.

pub fn is_dismissed_by_key(&self, key: &str) -> SuggestApiResult<bool>

Return whether a suggestion has been dismissed given its dismissal key.

SuggestStore::query will never return dismissed suggestions, so normally you never need to know whether a suggestion has been dismissed. This method is intended for cases where a dismissal key originates outside this component.

pub fn any_dismissed_suggestions(&self) -> SuggestApiResult<bool>

Return whether any suggestions have been dismissed.

pub fn interrupt(&self, kind: Option<InterruptKind>)

Interrupts any ongoing queries.

This should be called when the user types new input into the address bar, to ensure that they see fresh suggestions as they type. This method does not interrupt any ongoing ingests.

pub fn ingest( &self, constraints: SuggestIngestionConstraints, ) -> SuggestApiResult<SuggestIngestionMetrics>

Ingests new suggestions from Remote Settings.

pub fn clear(&self) -> SuggestApiResult<()>

Removes all content from the database.

pub fn fetch_global_config(&self) -> SuggestApiResult<SuggestGlobalConfig>

Returns global Suggest configuration data.

pub fn fetch_provider_config( &self, provider: SuggestionProvider, ) -> SuggestApiResult<Option<SuggestProviderConfig>>

Returns per-provider Suggest configuration data.

pub fn fetch_geonames( &self, query: &str, match_name_prefix: bool, filter: Option<Vec<Geoname>>, ) -> SuggestApiResult<Vec<GeonameMatch>>

Fetches geonames stored in the database. A geoname represents a geographic place.

See fetch_geonames in geoname.rs for documentation.

pub fn fetch_geoname_alternates( &self, geoname: &Geoname, ) -> SuggestApiResult<GeonameAlternates>

Fetches a geoname’s names stored in the database.

See fetch_geoname_alternates in geoname.rs for documentation.

impl SuggestStore

pub fn force_reingest(&self)

impl SuggestStore

pub fn checkpoint(&self)

Creates a WAL checkpoint. This will cause changes in the write-ahead log to be written to the DB. See: https://sqlite.org/pragma.html#pragma_wal_checkpoint

Trait Implementations

impl<UT> LiftRef<UT> for SuggestStore

type LiftType = Arc<SuggestStore>

impl<UT> LowerError<UT> for SuggestStore

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SuggestStore

type ReturnType = <Arc<SuggestStore> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for SuggestStore

const TYPE_ID_META: MetadataBuffer