Struct FeaturedDocument 

#[non_exhaustive]
pub struct FeaturedDocument {
    pub id: Option<String>,
}

A featured document. 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 document to feature in the search results. 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.

Implementations

impl FeaturedDocument

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

The identifier of the document to feature in the search results. 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.

impl FeaturedDocument

pub fn builder() -> FeaturedDocumentBuilder

Creates a new builder-style object to manufacture FeaturedDocument.

Trait Implementations

impl Clone for FeaturedDocument

fn clone(&self) -> FeaturedDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeaturedDocument

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

Formats the value using the given formatter.

impl PartialEq for FeaturedDocument

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FeaturedDocument