Struct merino_suggest_providers::providers::id_multi::IdMulti

pub struct IdMulti {
    providers: HashMap<String, Box<dyn SuggestionProvider>>,
}

A provider that aggregates suggestions from suggesters that tracks an ID per suggester (or suggester tree).

Fields

providers: HashMap<String, Box<dyn SuggestionProvider>>

The providers to aggregate from.

Implementations

impl IdMulti

pub fn new(providers: HashMap<String, Box<dyn SuggestionProvider>>) -> Self

Create a Multi that draws suggestions from providers.

pub fn add_provider(
    &mut self,
    name: String,
    provider: Box<dyn SuggestionProvider>
) -> &mut Self

Modify this provider to include another named provider tree.

pub fn list_providers(&self) -> Vec<ProviderDetails>

Return metadata about the contained providers.

pub async fn suggest_from_ids(
    &self,
    request: SuggestionRequest,
    ids: &HashSet<String>
) -> Result<SuggestionResponse, SuggestError>

Provide suggested results for query using only the providers listed by ID.

Errors

Returns an error if any sub providers return an error.

pub fn get_provider_mut(
    &mut self,
    name: &str
) -> Option<&mut Box<dyn SuggestionProvider>>

Get a mutable reference to a provider by name.

Trait Implementations

impl Default for IdMulti

fn default() -> IdMulti

Returns the “default value” for a type.

impl SuggestionProvider for IdMulti

fn name(&self) -> String

An operator-visible name for this suggestion provider.

fn cache_inputs(
    &self,
    req: &SuggestionRequest,
    cache_inputs: &mut dyn CacheInputs
)

Generate a set of cache inputs for a given query specific to this provider. Any property of the query that affects how suggestions are generated should be included.

fn suggest<'life0, 'async_trait>(
    &'life0 self,
    request: SuggestionRequest
) -> Pin<Box<dyn Future<Output = Result<SuggestionResponse, SuggestError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Provide suggested results for query.

fn reconfigure<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    new_config: Value,
    make_fresh: &'life1 MakeFreshType
) -> Pin<Box<dyn Future<Output = Result<(), SetupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Reconfigure the provider, using a new configuration object. State should be preserved if possible.

fn is_null(&self) -> bool

Return if this provider is null and can be ignored. Providers that set this to true should be ignored in any place where suggestions are needed. Providers with this set to true likely only serve as a blank space where we may need a provider but can’t otherwise supply one.

fn cache_key(&self, req: &SuggestionRequest) -> String

Use Self::cache_inputs to generate a single cache key. This function should not normally be overridden by provider implementations.