Struct meilisearch_sdk::search::SearchResults

pub struct SearchResults<T> {

    pub hits: Vec<SearchResult<T>>,
    pub offset: Option<usize>,
    pub limit: Option<usize>,
    pub estimated_total_hits: Option<usize>,
    pub page: Option<usize>,
    pub hits_per_page: Option<usize>,
    pub total_hits: Option<usize>,
    pub total_pages: Option<usize>,
    pub facet_distribution: Option<HashMap<String, HashMap<String, usize>>>,
    pub facet_stats: Option<HashMap<String, FacetStats>>,
    pub processing_time_ms: usize,
    pub query: String,
    pub index_uid: Option<String>,
}

A struct containing search results and other information about the search.

Fields

hits: Vec<SearchResult<T>>

Results of the query.

offset: Option<usize>

Number of documents skipped.

limit: Option<usize>

Number of results returned.

estimated_total_hits: Option<usize>

Estimated total number of matches.

page: Option<usize>

hits_per_page: Option<usize>

total_hits: Option<usize>

total_pages: Option<usize>

facet_distribution: Option<HashMap<String, HashMap<String, usize>>>

Distribution of the given facets.

facet_stats: Option<HashMap<String, FacetStats>>

facet stats of the numerical facets requested in the facet search parameter.

processing_time_ms: usize

Processing time of the query.

query: String

Query originating the response.

index_uid: Option<String>

Index uid on which the search was made.

Trait Implementations

impl<T: Clone> Clone for SearchResults<T>

fn clone(&self) -> SearchResults<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for SearchResults<T>

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.