Struct merino_suggest_providers::StealthProvider

pub struct StealthProvider {
    inner: Box<dyn SuggestionProvider>,
}

A provider that runs inner, but doesn’t return any results.

Fields

inner: Box<dyn SuggestionProvider>

The provider to run but not provide suggestions from.

Implementations

impl StealthProvider

pub fn new_boxed(inner: Box<dyn SuggestionProvider>) -> Box<Self>

Make a new stealth provider, wrapping the given provider.

Trait Implementations

impl SuggestionProvider for StealthProvider

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.