Struct SearchDocument 

pub struct SearchDocument {
    pub id: String,
    pub kind: String,
    pub title: String,
    pub summary: String,
    pub content: String,
}

Searchable document contributed by commands, guides, or applications.

Fields

id: String

Stable document id.

kind: String

Document kind, such as command or guide.

title: String

Search result title.

summary: String

Short snippet shown in search results.

content: String

Full searchable content.

Implementations

impl SearchDocument

pub fn new( id: impl Into<String>, kind: impl Into<String>, title: impl Into<String>, ) -> Self

Creates a searchable document with title text as the default content.

pub fn with_summary(self, summary: impl Into<String>) -> Self

Sets the short snippet shown in search results.

pub fn with_content(self, content: impl Into<String>) -> Self

Sets the full searchable content.

Trait Implementations

impl Clone for SearchDocument

fn clone(&self) -> SearchDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchDocument

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

Formats the value using the given formatter.

impl PartialEq for SearchDocument

fn eq(&self, other: &SearchDocument) -> 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 SearchDocument