Struct algoliasearch::index::SearchQueryBuilder

pub struct SearchQueryBuilder { /* fields omitted */ }

Builder for SearchQuery.

Methods

impl SearchQueryBuilder

pub fn query<VALUE: Into<Option<String>>>(&mut self, value: VALUE) -> &mut Self

pub fn attributes_to_retrieve<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

pub fn restrict_searchable_attributes<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self

pub fn page<VALUE: Into<Option<u64>>>(&mut self, value: VALUE) -> &mut Self

pub fn hits_per_page<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self

pub fn offset<VALUE: Into<Option<u64>>>(&mut self, value: VALUE) -> &mut Self

pub fn length<VALUE: Into<Option<u64>>>(&mut self, value: VALUE) -> &mut Self

pub fn build(&self) -> Result<SearchQuery, String>

Builds a new SearchQuery.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for SearchQueryBuilder

fn clone(&self) -> SearchQueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SearchQueryBuilder

fn default() -> SearchQueryBuilder

Returns the "default value" for a type.