Struct SearchPreview 

pub struct SearchPreview {
    pub title: Option<String>,
    pub facts: Vec<String>,
    pub lines: Vec<String>,
    pub body: Option<String>,
}

The preview of one search hit.

Fields

title: Option<String>

What the preview is of, as its heading.

facts: Vec<String>

Short facts shown side by side in columns: a site, a count, a date.

lines: Vec<String>

Items it holds or lists, one per line: a feed’s latest entries, a folder’s feeds.

body: Option<String>

The start of its text, wrapped over a few lines.

Implementations

impl SearchPreview

pub fn titled(title: impl Into<String>) -> SearchPreview

A preview headed title.

pub fn fact(self, fact: impl Into<String>) -> SearchPreview

One more fact on its facts line; an empty one adds nothing.

pub fn line(self, line: impl Into<String>) -> SearchPreview

One more item line; an empty one adds nothing.

pub fn body(self, body: impl Into<String>) -> SearchPreview

The start of its text; an empty one sets none.

pub fn is_empty(&self) -> bool

Whether it says anything at all.

pub fn restates(&self, title: &str) -> bool

Whether it says no more than title already does: it has no heading of its own and every part it shows is that same text. A band under a row that repeats the row’s own line says nothing, so the platform draws none.

pub fn spoken(&self) -> String

The whole preview as one sentence for a screen reader.

Trait Implementations

impl Clone for SearchPreview

fn clone(&self) -> SearchPreview

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchPreview

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

Formats the value using the given formatter.

impl Default for SearchPreview

fn default() -> SearchPreview

Returns the “default value” for a type.

impl From<&str> for SearchPreview

fn from(body: &str) -> SearchPreview

Converts to this type from the input type.

impl From<String> for SearchPreview

Plain text alone previews as its body.

fn from(body: String) -> SearchPreview

Converts to this type from the input type.

impl PartialEq for SearchPreview

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

impl StructuralPartialEq for SearchPreview