Struct ExpandedResultItem 

#[non_exhaustive]
pub struct ExpandedResultItem {
    pub id: Option<String>,
    pub document_id: Option<String>,
    pub document_title: Option<TextWithHighlights>,
    pub document_excerpt: Option<TextWithHighlights>,
    pub document_uri: Option<String>,
    pub document_attributes: Option<Vec<DocumentAttribute>>,
}

A single expanded result in a collapsed group of search results.

An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<String>

The identifier for the expanded result.

document_id: Option<String>

The idenitifier of the document.

document_title: Option<TextWithHighlights>

Provides text and information about where to highlight the text.

document_excerpt: Option<TextWithHighlights>

Provides text and information about where to highlight the text.

document_uri: Option<String>

The URI of the original location of the document.

document_attributes: Option<Vec<DocumentAttribute>>

An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

Implementations

impl ExpandedResultItem

pub fn id(&self) -> Option<&str>

The identifier for the expanded result.

pub fn document_id(&self) -> Option<&str>

The idenitifier of the document.

pub fn document_title(&self) -> Option<&TextWithHighlights>

Provides text and information about where to highlight the text.

pub fn document_excerpt(&self) -> Option<&TextWithHighlights>

Provides text and information about where to highlight the text.

pub fn document_uri(&self) -> Option<&str>

The URI of the original location of the document.

pub fn document_attributes(&self) -> &[DocumentAttribute]

An array of document attributes assigned to a document in the search results. For example, the document author ("_author") or the source URI ("_source_uri") of the document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_attributes.is_none().

impl ExpandedResultItem

pub fn builder() -> ExpandedResultItemBuilder

Creates a new builder-style object to manufacture ExpandedResultItem.

Trait Implementations

impl Clone for ExpandedResultItem

fn clone(&self) -> ExpandedResultItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExpandedResultItem

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

Formats the value using the given formatter.

impl PartialEq for ExpandedResultItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ExpandedResultItem