Struct SearchBuilder

Source

pub struct SearchBuilder<Q, E, L> { /* private fields */ }

Expand description

A SearchBuilder can be used to configure and perform a search

Implementations§

Source §

impl<E, L> SearchBuilder<NoQuery, E, L>

Source

pub fn query(self, query: impl Into<String>) -> SearchBuilder<WithQuery, E, L>

Search for page titles or content matching this value

Source §

impl<Q, L> SearchBuilder<Q, NoEndpoint, L>

Source

pub fn endpoint(self, endpoint: Endpoint) -> SearchBuilder<Q, WithEndpoint, L>

API endpoint for the MediaWiki site to perform the search on

Source §

impl<Q, E> SearchBuilder<Q, E, NoLanguage>

Source

pub fn language(self, language: Language) -> SearchBuilder<Q, E, WithLanguage>

Language where the search will be performed in

Source §

impl<Q, E, L> SearchBuilder<Q, E, L>

Source

pub fn namespace(self, namespace: Namespace) -> Self

Search only in this specific namespace

Source

pub fn limit(self, limit: usize) -> Self

How many total pages to return. The value must be between 1 and 500

Default: 10

Source

pub fn offset(self, offset: usize) -> Self

When more results are available, use the offset to continue Default: 0

Source

pub fn qiprofile(self, qiprofile: QiProfile) -> Self

Query independent profile to use which affects the ranking algorithm

Default: QiProfile::EngineAutoselect

Source

pub fn search_type(self, search_type: SearchType) -> Self

Which search to perform

Default: SearchType::Text

Source

pub fn info(self, info: Info) -> Self

Which metadata to return

Default: [Info::TotalHits, Info::Suggestion, Info::RewrittenQuery]

Source

pub fn properties(self, properties: Vec<Property>) -> Self

Which properties about the search results to return

Default: [Property::Size, Property::WordCount, Property::Timestamp, Property::Snippet]

Source

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

Include interwiki results in the search, if available

Default: false

Source

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

Enable internal query rewriting. Some search backends can rewrite the query into another which is thought to provide better results, for instance by correcting spelling errors

Default: false

Source

pub fn sort_order(self, sort_order: SortOrder) -> Self

Set the sort order of returend results

Default: SortOrder::Relevance

Source §

impl SearchBuilder<WithQuery, WithEndpoint, WithLanguage>

Source

pub async fn search(self) -> Result<Search>

Performes the search and returns the result. The search can only be made when the query, endpoint and language are set

§Example

// This searches for the pages containing 'meaning' in the english wikipedia
let search = Search::builder()
    .query("meaning")
    .endpoint(Url::from("https://en.wikipedia.org/w/api.php")?)
    .language(Language::English)
    .search()?;