Struct GatewaySearch 

#[non_exhaustive]
pub struct GatewaySearch { /* private fields */ }

The [SearchProvider] a Host supplies to search the web through the Gateway.

It sends every search to one Gateway API root with the Gateway’s shared bearer key. Each search is one POST {api_root}/tools/web_search request under a 30-second deadline. The deadline covers the whole exchange, including reading the reply body. The search vendor’s credential stays in the Gateway. This provider sends only the Gateway’s key.

Implementations

impl GatewaySearch

pub fn new(endpoint: GatewayEndpoint, key: SecretString) -> GatewaySearch

Builds a search provider from a validated GatewayEndpoint and a redacted SecretString bearer key.

Trait Implementations

impl Clone for GatewaySearch

fn clone(&self) -> GatewaySearch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GatewaySearch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SearchProvider for GatewaySearch

fn search<'life0, 'async_trait>( &'life0 self, query: SearchQuery, ) -> Pin<Box<dyn Future<Output = Result<SearchResults, SearchError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Runs query as one Gateway web search and returns the Gateway’s results with every field copied as the Gateway sent it.

Errors

Returns a [SearchError] with the message of the GatewaySearchError it keeps as its source. Its kind is:

• Transport when sending the request fails (request failed) or reading a successful reply fails (reading response failed), including when the deadline passes;
• Backend when the Gateway answers a failure status (backend returned {code}: {body}, or backend returned {code}, and its error body could not be read), or a success body that is over 256 KiB (response body exceeded {limit} bytes), is invalid UTF-8 (response body was not valid UTF-8), or fails to parse as a search reply (malformed search response).