[−][src]Struct algoliasearch::index::SearchQueryBuilder

pub struct SearchQueryBuilder { /* fields omitted */ }

Builder for SearchQuery.

Methods

impl SearchQueryBuilder[src]

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

https://www.algolia.com/doc/api-reference/api-parameters/query/

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

https://www.algolia.com/doc/api-reference/api-parameters/attributesToRetrieve/

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

pub fn filters<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/filters/

pub fn facet_filters<VALUE: Into<Option<Vec<StringOrVecOfString>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/facetFilters/

pub fn optional_filters<VALUE: Into<Option<Vec<StringOrVecOfString>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/optionalFilters/

pub fn numeric_filters<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/

pub fn tag_filters<VALUE: Into<Option<StringOrVecOfString>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/

pub fn sum_or_filters_scores<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/sumOrFiltersScores/

pub fn facets<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/facets/

pub fn max_values_per_facet<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/maxValuesPerFacet/

pub fn faceting_after_distinct<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/facetingAfterDistinct/

pub fn sort_facet_values_by<VALUE: Into<Option<SortFacetValuesBy>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/sortFacetValuesBy/

pub fn attributes_to_highlight<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/attributesToHighlight/

pub fn attributes_to_snippet<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/attributesToSnippet/

pub fn highlight_pre_tag<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/highlightPreTag/

pub fn highlight_post_tag<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/highlightPostTag/

pub fn snippet_ellipsis_text<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/snippetEllipsisText/

pub fn restrict_highlight_and_snippet_arrays<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/restrictHighlightAndSnippetArrays/

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

https://www.algolia.com/doc/api-reference/api-parameters/page/

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

https://www.algolia.com/doc/api-reference/api-parameters/hitsPerPage/

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

https://www.algolia.com/doc/api-reference/api-parameters/offset/

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

https://www.algolia.com/doc/api-reference/api-parameters/length/

pub fn min_word_sizefor_1_typo<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor1Typo/

pub fn min_word_sizefor_2_typos<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/minWordSizefor2Typos/

pub fn typo_tolerance<VALUE: Into<Option<TypoTolerance>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/typoTolerance/

pub fn allow_typos_on_numeric_tokens<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/allowTyposOnNumericTokens/

pub fn disable_typo_tolerance_on_attributes<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/disableTypoToleranceOnAttributes/

pub fn around_lat_lng<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/aroundLatLng/

pub fn around_lat_lng_via_ip<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/aroundLatLngViaIP/

pub fn around_radius<VALUE: Into<Option<AroundRadius>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/aroundRadius/

pub fn around_precision<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/aroundPrecision/

pub fn minimum_around_radius<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/minimumAroundRadius/

pub fn inside_bounding_box<VALUE: Into<Option<Vec<f64>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/insideBoundingBox/

pub fn inside_polygon<VALUE: Into<Option<Vec<f64>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/insidePolygon/

pub fn ignore_plurals<VALUE: Into<Option<IgnorePlurals>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/

pub fn remove_stop_words<VALUE: Into<Option<IgnorePlurals>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/removeStopWords/

pub fn query_languages<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/queryLanguages/

pub fn query_type<VALUE: Into<Option<QueryType>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/queryType/

pub fn remove_words_if_no_results<VALUE: Into<Option<RemoveWordsIfNoResults>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/removeWordsIfNoResults/

pub fn advanced_syntax<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/advancedSyntax/

pub fn optional_words<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/optionalWords/

pub fn disable_exact_on_attributes<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/disableExactOnAttributes/

pub fn exact_on_single_word_query<VALUE: Into<Option<ExactOnSingleWordQuery>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/exactOnSingleWordQuery/

pub fn alternatives_as_exact<VALUE: Into<Option<AlternativesAsExact>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/alternativesAsExact/

pub fn enable_rules<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/enableRules/

pub fn rule_contexts<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/ruleContexts/

pub fn enable_personalization<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/enablePersonalization/

pub fn user_token<VALUE: Into<Option<String>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/userToken/

pub fn distinct<VALUE: Into<Option<Distinct>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/distinct/

pub fn get_ranking_info<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/getRankingInfo/

pub fn click_analytics<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/clickAnalytics/

pub fn analytics<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/analytics/

pub fn analytics_tags<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/analyticsTags/

pub fn synonyms<VALUE: Into<Option<bool>>>(&mut self, value: VALUE) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/synonyms/

pub fn replace_synonyms_in_highlight<VALUE: Into<Option<bool>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/replaceSynonymsInHighlight/

pub fn min_proximity<VALUE: Into<Option<MinProximity>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/minProximity/

pub fn response_fields<VALUE: Into<Option<Vec<String>>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/responseFields/

pub fn max_facet_hits<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/maxFacetHits/

pub fn percentile_computation<VALUE: Into<Option<u64>>>(
    &mut self,
    value: VALUE
) -> &mut Self[src]

https://www.algolia.com/doc/api-reference/api-parameters/percentileComputation/

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

Builds a new SearchQuery.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for SearchQueryBuilder[src]

impl Clone for SearchQueryBuilder[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

Auto Trait Implementations

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> BorrowMut for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Erased for T

impl<T, U> TryInto for T where
    U: TryFrom<T>, 

type Err = <U as TryFrom<T>>::Err