Enum SearchRow 

pub enum SearchRow {
    Message {
        sender: String,
        subject: String,
        snippet: Option<String>,
        date: Option<String>,
        unread: bool,
    },
    Media {
        thumbnail: Option<AppImage>,
        title: String,
        byline: Option<String>,
        duration: Option<String>,
    },
    FileHit {
        path: String,
        line: Option<u32>,
        snippet: String,
        matched: Option<Range<usize>>,
    },
    Command(Box<CommandRow>),
    Item {
        app: String,
        kind: String,
        id: String,
    },
}

The shape of one search hit’s row.

Variants

Message

A message: who sent it, its subject, a snippet of its body, when it arrived, and whether it is unread (a dot before the sender).

Fields

sender: String

subject: String

snippet: Option<String>

date: Option<String>

unread: bool

Media

A video, track or other media item: its thumbnail, title, who made it (the channel or artist), and its duration.

Fields

thumbnail: Option<AppImage>

title: String

byline: Option<String>

duration: Option<String>

FileHit

A match inside a file: the file’s path, the line, and the matched line itself with the matched span marked (byte range into snippet).

Fields

path: String

line: Option<u32>

snippet: String

matched: Option<Range<usize>>

Command(Box<CommandRow>)

A command, place or person: the title over an optional description (the result’s subtitle), with what leads and trails it.

Item

An item of a published resource: the app that keeps it, the item’s kind and its id. A hit is a reference to what it opens, never a copy of it: choosing one runs the app’s open at the item, and the row it is drawn with is the app’s own. An entry the app gives a shape of its own (Self::Message, Self::Media) says how it reads already; one without any is this.

Fields

app: String

The app that keeps the item (so.tilo.notes).

kind: String

The item’s kind (notes.notebook.pages).

id: String

The item’s id in that app.

Implementations

impl SearchRow

pub fn message( sender: impl Into<String>, subject: impl Into<String>, ) -> SearchRow

pub fn media(title: impl Into<String>) -> SearchRow

pub fn file_hit( path: impl Into<String>, snippet: impl Into<String>, ) -> SearchRow

A file-hit row for snippet, the matched line of path.

pub fn item( app: impl Into<String>, kind: impl Into<String>, id: impl Into<String>, ) -> SearchRow

The item id of the kind kind in app, as a reference.

pub fn item_of(app: impl Into<String>, resource: &str) -> Option<SearchRow>

The item row for resource (notes.notebook/pages/<id>) of app: what a hit on a resource an app publishes as items is drawn with. None when resource names no item of an app (a whole notebook, an app’s own surface), which is drawn as the generic row.

pub fn item_resource(&self) -> Option<String>

The resource id of the item this row is, when it is one: <resource>/<collection>/<id> (notes.notebook/pages/<id>), the address its app’s open shows. None for a row that names no item.

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

The app keeping the item this row is, when it is one.

pub fn snippet(self, text: impl Into<String>) -> SearchRow

The message’s body snippet, or a file hit’s matched line.

pub fn date(self, text: impl Into<String>) -> SearchRow

When a message arrived, already formatted (“Tue”, “12 Mar”).

pub fn unread(self, on: bool) -> SearchRow

pub fn thumbnail(self, image: AppImage) -> SearchRow

pub fn byline(self, text: impl Into<String>) -> SearchRow

The channel, artist or author of a media item.

pub fn duration(self, text: impl Into<String>) -> SearchRow

A media item’s duration, already formatted (“12:04”).

pub fn line(self, number: u32) -> SearchRow

The 1-based line of a file hit.

pub fn matched(self, range: Range<usize>) -> SearchRow

The matched span of a file hit’s snippet, as a byte range. A range that is not on character boundaries of the snippet is ignored.

pub fn spoken(&self) -> String

The text a screen reader announces for the row, in reading order.

pub fn location(&self) -> Option<String>

The row’s location line: path:line for a file hit.

Trait Implementations

impl Clone for SearchRow

fn clone(&self) -> SearchRow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchRow

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

Formats the value using the given formatter.

impl PartialEq for SearchRow

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