Struct FeaturedDocumentWithMetadata 

#[non_exhaustive]
pub struct FeaturedDocumentWithMetadata {
    pub id: Option<String>,
    pub title: Option<String>,
    pub uri: Option<String>,
}

A featured document with its metadata information. This document is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then the document is featured in the search results.

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 of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

title: Option<String>

The main title of the featured document.

uri: Option<String>

The source URI location of the featured document.

Implementations

impl FeaturedDocumentWithMetadata

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

The identifier of the featured document with its metadata. You can use the Query API to search for specific documents with their document IDs included in the result items, or you can use the console.

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

The main title of the featured document.

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

The source URI location of the featured document.

impl FeaturedDocumentWithMetadata

pub fn builder() -> FeaturedDocumentWithMetadataBuilder

Creates a new builder-style object to manufacture FeaturedDocumentWithMetadata.

Trait Implementations

impl Clone for FeaturedDocumentWithMetadata

fn clone(&self) -> FeaturedDocumentWithMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeaturedDocumentWithMetadata

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

Formats the value using the given formatter.

impl PartialEq for FeaturedDocumentWithMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FeaturedDocumentWithMetadata