Struct SearchEngineSelector

pub struct SearchEngineSelector(/* private fields */);

SearchEngineSelector parses the JSON configuration for search engines and returns the applicable engines depending on their region + locale.

Implementations

impl SearchEngineSelector

pub fn new() -> Self

pub fn use_remote_settings_server( self: Arc<Self>, service: &Arc<RemoteSettingsService>, apply_engine_overrides: bool, ) -> SearchApiResult<()>

Sets the RemoteSettingsService to use. The selector will create the relevant remote settings client(s) from the service.

Params:

• service: The remote settings service instance for the application.
• options: The remote settings options to be passed to the client(s).
• apply_engine_overrides: Whether or not to apply overrides from search-config-v2-overrides to the selected engines. Should be false unless the application supports the click URL feature.

pub fn set_search_config( self: Arc<Self>, configuration: String, ) -> SearchApiResult<()>

Sets the search configuration from the given string. If the configuration string is unchanged since the last update, the cached configuration is reused to avoid unnecessary reprocessing. This helps optimize performance, particularly during test runs where the same configuration may be used repeatedly.

pub fn set_config_overrides( self: Arc<Self>, overrides: String, ) -> SearchApiResult<()>

pub fn clear_search_config(self: Arc<Self>)

Clears the search configuration from memory if it is known that it is not required for a time, e.g. if the configuration will only be re-filtered after an app/environment update.

pub fn filter_engine_configuration( self: Arc<Self>, user_environment: SearchUserEnvironment, ) -> SearchApiResult<RefinedSearchConfig>

Filters the search configuration with the user’s given environment, and returns the set of engines and parameters that should be presented to the user.

Trait Implementations

impl Default for SearchEngineSelector

fn default() -> SearchEngineSelector

Returns the “default value” for a type.

impl<UT> LiftRef<UT> for SearchEngineSelector

type LiftType = Arc<SearchEngineSelector>

impl<UT> LowerError<UT> for SearchEngineSelector

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SearchEngineSelector

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

const TYPE_ID_META: MetadataBuffer = _