Struct elasticsearch_dsl::search::request::Search

source · [−]

pub struct Search { /* private fields */ }

Expand description

Returns search hits that match the query defined in the request.

https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html

Implementations

source

impl Search

source

pub fn new() -> Self

Creates a default search instance

source

pub fn runtime_mapping<S>(self, name: S, mapping: RuntimeMapping) -> Self where
S: ToString,

Add runtime mapping to the search request

source

pub fn indices_boost<F, B>(self, field: F, boost: B) -> Self where
F: ToString,
B: TryInto<Boost>,

Allows to configure different boost level per index when searching across more than one indices. This is very handy when hits coming from one index matter more than hits coming from another index (think social graph where each user has an index).

source

pub fn min_score<F>(self, min_score: F) -> Self where
F: Into<f32>,

Exclude documents which have a _score less than the minimum specified in min_score

Note, most times, this does not make much sense, but is provided for advanced use cases

source

pub fn source<S>(self, source: S) -> Self where
S: Into<SourceFilter>,

Indicates which source fields are returned for matching documents

source

pub fn stats<S>(self, stats: S) -> Self where
S: ToString,

Specific tag of the request for logging and statistical purposes.

source

pub fn from<S>(self, from: S) -> Self where
S: TryInto<u64>,

Starting document offset.

Defaults to 0.

source

pub fn size<S>(self, size: S) -> Self where
S: TryInto<u64>,

The number of hits to return.

Defaults to 10.

source

pub fn query<Q>(self, query: Q) -> Self where
Q: Into<Query>,

Defines the search definition using the Query DSL.

source

pub fn sort<S>(self, sort: S) -> Self where
S: Into<Vec<Sort>>,

A collection of sorting fields

source

pub fn track_total_hits<T>(self, track_total_hits: T) -> Self where
T: Into<TrackTotalHits>,

Track total hits

source

pub fn highlight<H>(self, highlight: H) -> Self where
H: Into<Highlight>,

Highlight

source

pub fn rescore<R>(self, rescore: R) -> Self where
R: Into<Rescore>,

Rescore

source

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Self where
N: Into<AggregationName>,
A: Into<Aggregation>,

Pushes aggregation

Trait Implementations

source

impl Clone for Search

source

fn clone(&self) -> Search

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Search

source

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

Formats the value using the given formatter. Read more

source

impl Default for Search

source

fn default() -> Search

Returns the “default value” for a type. Read more

source

impl PartialEq<Search> for Search

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

impl Serialize for Search

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl StructuralPartialEq for Search

Auto Trait Implementations

impl RefUnwindSafe for Search

impl Send for Search

impl Sync for Search

impl Unpin for Search

impl UnwindSafe for Search

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct elasticsearch_dsl::search::request::Search

Implementations

impl Search

pub fn new() -> Self

pub fn runtime_mapping<S>(self, name: S, mapping: RuntimeMapping) -> Self where S: ToString,

pub fn indices_boost<F, B>(self, field: F, boost: B) -> Self where F: ToString, B: TryInto<Boost>,

pub fn min_score<F>(self, min_score: F) -> Self where F: Into<f32>,

pub fn source<S>(self, source: S) -> Self where S: Into<SourceFilter>,

pub fn stats<S>(self, stats: S) -> Self where S: ToString,

pub fn from<S>(self, from: S) -> Self where S: TryInto<u64>,

pub fn size<S>(self, size: S) -> Self where S: TryInto<u64>,

pub fn query<Q>(self, query: Q) -> Self where Q: Into<Query>,

pub fn sort<S>(self, sort: S) -> Self where S: Into<Vec<Sort>>,

pub fn track_total_hits<T>(self, track_total_hits: T) -> Self where T: Into<TrackTotalHits>,

pub fn highlight<H>(self, highlight: H) -> Self where H: Into<Highlight>,

pub fn rescore<R>(self, rescore: R) -> Self where R: Into<Rescore>,

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Self where N: Into<AggregationName>, A: Into<Aggregation>,

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

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

impl Debug for Search

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

impl Default for Search

fn default() -> Search

impl PartialEq<Search> for Search

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

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

impl Serialize for Search

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

impl StructuralPartialEq for Search

Auto Trait Implementations

impl RefUnwindSafe for Search

impl Send for Search

impl Sync for Search

impl Unpin for Search

impl UnwindSafe for Search

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

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

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn runtime_mapping<S>(self, name: S, mapping: RuntimeMapping) -> Self where
S: ToString,

pub fn indices_boost<F, B>(self, field: F, boost: B) -> Self where
F: ToString,
B: TryInto<Boost>,

pub fn min_score<F>(self, min_score: F) -> Self where
F: Into<f32>,

pub fn source<S>(self, source: S) -> Self where
S: Into<SourceFilter>,

pub fn stats<S>(self, stats: S) -> Self where
S: ToString,

pub fn from<S>(self, from: S) -> Self where
S: TryInto<u64>,

pub fn size<S>(self, size: S) -> Self where
S: TryInto<u64>,

pub fn query<Q>(self, query: Q) -> Self where
Q: Into<Query>,

pub fn sort<S>(self, sort: S) -> Self where
S: Into<Vec<Sort>>,

pub fn track_total_hits<T>(self, track_total_hits: T) -> Self where
T: Into<TrackTotalHits>,

pub fn highlight<H>(self, highlight: H) -> Self where
H: Into<Highlight>,

pub fn rescore<R>(self, rescore: R) -> Self where
R: Into<Rescore>,

pub fn aggregate<N, A>(self, aggregation_name: N, aggregation: A) -> Self where
N: Into<AggregationName>,
A: Into<Aggregation>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

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

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