Struct IndexEntry 

pub struct IndexEntry {

    pub key: String,
    pub resource: String,
    pub action: Option<IndexAction>,
    pub title: String,
    pub subtitle: Option<String>,
    pub group: Option<String>,
    pub kind: Option<IndexKind>,
    pub people: Vec<IndexPerson>,
    pub keeper: Option<IndexPerson>,
    pub place: Option<IndexPerson>,
    pub when: Option<i64>,
    pub icon: Option<String>,
    pub boost: i32,
    pub fields: Vec<(String, IndexWeight)>,
    pub secret: bool,
    pub references: Vec<String>,
}

One search entry, as the system index keeps it.

Fields

key: String

Stable within the app’s publication: the resource id, or the resource and action a hit invokes.

resource: String

The stable resource id a hit opens: the entry’s anchor, else the resource of its action. Without an action (or once it is gone) a hit opens the app here through its open action.

action: Option<IndexAction>

The published action a hit invokes, when the entry names one.

title: String

subtitle: Option<String>

group: Option<String>

The result group the app lists the entry under (“Passwords”).

kind: Option<IndexKind>

What kind of thing it is, when the app keeps something the desk’s generic rows would read poorly (an agent, a conversation, a message).

people: Vec<IndexPerson>

Who the row shows, in the order people read them: the first is its avatar, the rest its faces. The sender of a message, the people in a conversation, the agent itself.

keeper: Option<IndexPerson>

Who keeps it, for an agent: the row says so, and “you” when it is the person searching.

place: Option<IndexPerson>

Where it is, for a message: the conversation it sits in.

when: Option<i64>

When it happened, in seconds since the Unix epoch: the row says how long ago.

icon: Option<String>

A named icon (a lucide kebab name).

boost: i32

A nudge over an equal match (a favourite), never an override.

fields: Vec<(String, IndexWeight)>

More short text the entry is found by, each with its weight.

secret: bool

The entry describes a secret: found only while the app reports its secrets unlocked.

references: Vec<String>

What its text refers to, each in the one form a reference in rich text is written in (tilo_reference::embed): the system index finds the entry by what each is called now, not by the title written into the text, and answers which entries refer to a resource (its backlinks).

Implementations

impl IndexEntry

pub fn bounded(self) -> Option<IndexEntry>

The entry within this module’s bounds: texts cut, fields capped, empty fields dropped. None for an entry with nothing to find it by or nothing to open.

pub fn searchable(&self) -> impl Iterator<Item = (&str, IndexWeight)>

Every text the entry is found by, with its weight: its title, its secondary line and its fields.

Trait Implementations

impl Clone for IndexEntry

fn clone(&self) -> IndexEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexEntry

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

Formats the value using the given formatter.

impl Default for IndexEntry

fn default() -> IndexEntry

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexEntry

fn deserialize<__D>( __deserializer: __D, ) -> Result<IndexEntry, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for IndexEntry

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for IndexEntry

impl StructuralPartialEq for IndexEntry