Struct elasticsearch_dsl::search::SearchResponse

pub struct SearchResponse {

    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>>,
}

Search response

Fields

took: u32

The time that it took Elasticsearch to process the query

timed_out: bool

The search has been cancelled and results 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.

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

Performs copy-assignment from source.

impl Debug for SearchResponse

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

Formats the value using the given formatter.

impl Default for SearchResponse

fn default() -> SearchResponse

Returns the “default value” for a type.

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.

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 ==.

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

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

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.

impl StructuralPartialEq for SearchResponse