Struct relevancy::RelevancyStore

pub struct RelevancyStore { /* private fields */ }

Implementations

impl RelevancyStore

Top-level API for the Relevancy component

pub fn new(db_path: String) -> Self

Construct a new RelevancyStore

This is non-blocking since databases and other resources are lazily opened.

pub fn close(&self)

Close any open resources (for example databases)

Calling close will interrupt any in-progress queries on other threads.

pub fn interrupt(&self)

Interrupt any current database queries

pub fn ingest( &self, top_urls_by_frecency: Vec<String> ) -> ApiResult<InterestVector>

Ingest top URLs to build the user’s interest vector.

Consumer should pass a list of the user’s top URLs by frecency to this method. It will then:

• Download the URL interest data from remote settings. Eventually this should be cached / stored in the database, but for now it would be fine to download fresh data each time.
• Match the user’s top URls against the interest data to build up their interest vector.
• Store the user’s interest vector in the database.

This method may execute for a long time and should only be called from a worker thread.

pub fn calculate_metrics(&self) -> ApiResult<InterestMetrics>

Calculate metrics for the validation phase

This runs after Self::ingest. It takes the interest vector that ingest created and calculates a set of metrics that we can report to glean.

pub fn user_interest_vector(&self) -> ApiResult<InterestVector>

Get the user’s interest vector directly.

This runs after Self::ingest. It returns the interest vector directly so that the consumer can show it in an about: page.

impl RelevancyStore

pub fn ensure_interest_data_populated(&self) -> ApiResult<()>

Download the interest data from remote settings if needed

pub fn classify( &self, top_urls_by_frecency: Vec<String> ) -> Result<InterestVector>

Trait Implementations

impl<UT> LiftRef<UT> for RelevancyStore

type LiftType = Arc<RelevancyStore>

impl<UT> LowerError<UT> for RelevancyStore

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RelevancyStore

type ReturnType = <Arc<RelevancyStore> 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 RelevancyStore

const TYPE_ID_META: MetadataBuffer = _