Struct Search

pub struct Search {
    pub results: Vec<SearchResult>,
    pub endpoint: Endpoint,
    pub continue_offset: Option<usize>,
    pub info: SearchInfo,
}

A finished search containing the found results and additional optional information regarding the search

Fields

results: Vec<SearchResult>

The found results in this batch

endpoint: Endpoint

API endpoint of the MediaWiki site where the search was performed on

continue_offset: Option<usize>

If more results are available, use this offset to continue the search

info: SearchInfo

General information about the search

Implementations

impl Search

pub fn builder() -> SearchBuilder<NoQuery, NoEndpoint, NoLanguage>

Creates a SearchBuilder to configure and perform a search

pub fn continue_data(&self) -> Option<SearchContinue>

If available, returns the the data necessary for continuing the current search

When are more results available for the search, which can be checked via the Search::complete field, creates a SearchContinue data struct that contains all of the necessary information to continue the search at the correct offset.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl PartialEq for Search

fn eq(&self, other: &Search) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Search

impl StructuralPartialEq for Search