Struct elasticsearch_dsl::search::queries::params::InnerHits

pub struct InnerHits { /* private fields */ }

The parent-join and nested features allow the return of documents that have matches in a different scope. In the parent/child case, parent documents are returned based on matches in child documents or child documents are returned based on matches in parent documents. In the nested case, documents are returned based on matches in nested inner objects.

In both cases, the actual matches in the different scopes that caused a document to be returned are hidden. In many cases, it’s very useful to know which inner nested objects (in the case of nested) or children/parent documents (in the case of parent/child) caused certain information to be returned. The inner hits feature can be used for this. This feature returns per search hit in the search response additional nested hits that caused a search hit to match in a different scope.

Inner hits can be used by defining an inner_hits definition on a nested, has_child or has_parent query and filter.

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

Implementations

impl InnerHits

pub fn new() -> Self

Creates a new instance of InnerHits

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

Indicates which source fields are returned for matching documents

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

Starting document offset.

Defaults to 0.

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

The number of hits to return.

Defaults to 10.

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

A collection of sorting fields

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

Highlight

Trait Implementations

impl Clone for InnerHits

fn clone(&self) -> InnerHits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InnerHits

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

Formats the value using the given formatter.

impl Default for InnerHits

fn default() -> InnerHits

Returns the “default value” for a type.

impl PartialEq<InnerHits> for InnerHits

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

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

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

This method tests for !=.

impl Serialize for InnerHits

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 InnerHits