Struct elastic_responses::search::SearchResponse [] [src]

pub struct SearchResponse<T> { /* fields omitted */ }

Response for a search request.

This is the main struct of the crate, provides access to the hits and aggs iterators.

Aggregations

Aggregations currently have the following limitations:

Examples

Iterate over the hits in a search response:

let response: SearchResponse<Value> = do_request();

// Iterate over hits. Could also use `documents`
for hit in response.hits() {
    let score = hit.score().unwrap_or(f32::default());
    let doc = hit.document();
    
    println!("score: {}", score);
    println!("doc: {:?}", doc);
}

Methods

impl<T> SearchResponse<T>
[src]

Time in milliseconds it took for Elasticsearch to process the request.

Whether or not the request timed out before completing.

Shards metadata for the request.

A http status associated with the response.

The total number of documents that matched the search query.

The max score for documents that matched the search query.

Iterate over the hits matched by the search query.

Convert the response into an iterator that consumes the hits.

Iterate over the documents matched by the search query.

This iterator emits just the _source field for the returned hits.

Convert the response into an iterator that consumes the documents.

Iterate over the aggregations in the response.

This Iterator transforms the tree-like JSON object into a row/table based format for use with standard iterator adaptors.

Trait Implementations

impl<T: Debug> Debug for SearchResponse<T>
[src]

Formats the value using the given formatter.

impl<T: DeserializeOwned> IsOk for SearchResponse<T>
[src]

Inspect the http response to determine whether or not it succeeded.