Struct merino_suggest_providers::ClientVariantFilterProvider

pub struct ClientVariantFilterProvider {
    matching_provider: Box<dyn SuggestionProvider>,
    default_provider: Box<dyn SuggestionProvider>,
    client_variant: String,
}

A provider that gives suggestions base

Fields

matching_provider: Box<dyn SuggestionProvider>

Provider to use for suggestions if there is a client variant match

default_provider: Box<dyn SuggestionProvider>

Provider to use for suggestions if there isn’t a client variant match

client_variant: String

String use to match with client variants from suggest requests

Implementations

impl ClientVariantFilterProvider

pub fn new_boxed(
    matching_provider: Box<dyn SuggestionProvider>,
    default_provider: Box<dyn SuggestionProvider>,
    client_variant: String
) -> Box<Self>

Create a boxed Client Variant Provider

Trait Implementations

impl SuggestionProvider for ClientVariantFilterProvider

fn name(&self) -> String

An operator-visible name for this suggestion provider.

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 cache_inputs(
    &self,
    request: &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 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.