Struct elasticsearch_dsl::search::SearchResponse

source · [−]

pub struct SearchResponse {Show 13 fields
    pub took: u32,
    pub timed_out: bool,
    pub terminated_early: Option<bool>,
    pub scroll_id: Option<String>,
    pub fields: Map<String, Value>,
    pub pit_id: Option<String>,
    pub num_reduce_phases: Option<u64>,
    pub max_score: Option<f32>,
    pub clusters: Option<ClusterStatistics>,
    pub shards: ShardStatistics,
    pub hits: HitsMetadata,
    pub aggregations: Option<Value>,
    pub suggest: Map<String, Vec<Suggest>>,
}

Expand description

Search response

Fields

took: u32

The time that it took Elasticsearch to process the query

timed_out: bool

Indicates whether there have been timed-out shards, if true - responses are partial

terminated_early: Option<bool>

Indicates if search has been terminated early

scroll_id: Option<String>

Scroll Id

fields: Map<String, Value>

Dynamically fetched fields

pit_id: Option<String>

Point in time Id

num_reduce_phases: Option<u64>

Number of reduce phases

max_score: Option<f32>

Maximum document score. None when documents are implicitly sorted by a field other than _score

clusters: Option<ClusterStatistics>

Number of clusters touched with their states

shards: ShardStatistics

Number of shards touched with their states

hits: HitsMetadata

Search hits

aggregations: Option<Value>

Search aggregations

suggest: Map<String, Vec<Suggest>>

Suggest response

Implementations

impl SearchResponse

pub fn documents<T>(&self) -> Result<Vec<T>, Error> where
T: DeserializeOwned,

A shorthand for retrieving the _source for each hit

Trait Implementations

impl Clone for SearchResponse

fn clone(&self) -> SearchResponse

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

impl Debug for SearchResponse

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for SearchResponse

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq<SearchResponse> for SearchResponse

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

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

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

This method tests for !=.

impl Serialize for SearchResponse

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for SearchResponse

Auto Trait Implementations

impl RefUnwindSafe for SearchResponse

impl Send for SearchResponse

impl Sync for SearchResponse

impl Unpin for SearchResponse

impl UnwindSafe for SearchResponse

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,