Struct SearchRequest

pub struct SearchRequest { /* private fields */ }

Request object for the search API more info

Implementations

impl SearchRequest

pub fn new<S1, S2>(api_key: S1, query: S2) -> Self

where S1: AsRef<str> + Into<String>, S2: AsRef<str> + Into<String>,

Create a new search request

pub fn search_depth<S>(self, search_depth: S) -> Self

where S: AsRef<str> + Into<String>,

The depth of the search (“basic” or “advanced”). Default is basic for quick results and advanced for indepth high quality results but longer response time.

pub fn include_answer(self, include_answer: bool) -> Self

Include answers in the search results. Default is False.

pub fn include_images(self, include_images: bool) -> Self

Include a list of query related images in the response. Default is False.

pub fn include_raw_content(self, include_raw_content: bool) -> Self

Include raw content in the search results. Default is False.

pub fn max_results(self, max_results: i32) -> Self

The number of maximum search results to return. Default is 5.

pub fn include_domains<I, S>(self, include_domains: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str> + Into<String>,

A list of domains to specifically include in the search results. Default is None, which includes all domains.

pub fn exclude_domains<I, S>(self, exclude_domains: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str> + Into<String>,

A list of domains to specifically exclude from the search results. Default is None, which doesn’t exclude any domains.

pub fn topic<S>(self, topic: S) -> Self

where S: AsRef<str> + Into<String>,

Set the category of the search (“general” or “news”). Default is “general”.

pub fn days(self, days: i32) -> Self

Set the number of days back from the current date to include in search results. Only available when using the “news” search topic. Default is 3.

pub fn include_image_descriptions(self, include_descriptions: bool) -> Self

When include_images is set to True, this option adds descriptive text for each image. Default is False.

Trait Implementations

impl Debug for SearchRequest

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

Formats the value using the given formatter.

impl Default for SearchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for SearchRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.