Struct SearchEntry 

pub struct SearchEntry {

    pub within: Option<String>,
    pub row: Option<SearchRow>,
    pub anchor: Option<String>,
    pub title: String,
    pub text: String,
    pub action: Option<ActionAddress>,
    pub group: Option<String>,
    pub subtitle: Option<String>,
    pub icon: Option<String>,
    pub boost: i32,
    pub body: Option<SearchBody>,
    pub fields: Vec<(String, SearchWeight)>,
    pub facets: Vec<(String, String, String)>,
}

A search index entry. anchor addresses what a hit opens (an item id); action, when set, is the published action a hit invokes, so choosing it goes through the same door, permissions and history as the palette.

How a hit reads is the entry’s too: the result group it is listed under (the resource’s label unless group names another, such as “Timeline markers”), a dimmer subtitle line, a named icon (a lucide kebab name, "star"), and a boost that floats pinned or recent items over an equal match. Long prose an entry is found by — a book’s chapter, a long note — is its body, which the index reads in place rather than the entry copying it, and whose segments may each be a hit of their own.

Fields

within: Option<String>

The containing resource scope for a flat anchor.

row: Option<SearchRow>

Presentation for the platform-rendered result row.

anchor: Option<String>

title: String

text: String

action: Option<ActionAddress>

group: Option<String>

subtitle: Option<String>

icon: Option<String>

boost: i32

body: Option<SearchBody>

fields: Vec<(String, SearchWeight)>

More short text the entry is found by, each ranked by its own weight: a sender’s address, a book’s subject, a message’s labels.

facets: Vec<(String, String, String)>

Structured filter values: token key, localized group label, value.

Implementations

impl SearchEntry

pub fn facet( self, key: impl Into<String>, label: impl Into<String>, value: impl Into<String>, ) -> SearchEntry

Offer this entry under one value of a platform search facet.

pub fn in_scope(&self, scope: &str) -> bool

Whether the entry lies in scope: its anchor, or the scope it is within, is the scope or lies beneath it.

pub fn new(title: impl Into<String>, text: impl Into<String>) -> SearchEntry

An entry titled title whose body text is text.

pub fn inside(self, scope: impl Into<String>) -> SearchEntry

List the hit inside the scope scope (an item’s anchor) though its own anchor lies elsewhere: an article in its feed’s scope, related by a field rather than by nesting.

pub fn anchored(self, anchor: impl Into<String>) -> SearchEntry

The item a hit opens.

pub fn invoking(self, action: ActionAddress) -> SearchEntry

The published action a hit invokes.

pub fn opening<E>(self, row: impl Into<String>, effect: &E) -> SearchEntry

where E: Effect,

Anchored at the live row row, opened by running effect, the view effect that row offers (go to a bookmark, show a find match): for a hit whose row is the window’s own state rather than an item of the record.

pub fn grouped(self, group: impl Into<String>) -> SearchEntry

List hits under group rather than the resource’s label.

pub fn subtitled(self, subtitle: impl Into<String>) -> SearchEntry

A secondary line under the title: where the item is, what it is.

pub fn with_icon(self, icon: impl Into<String>) -> SearchEntry

The glyph a hit leads with, by its lucide kebab name ("star").

pub fn boosted(self, boost: i32) -> SearchEntry

Rank the hit boost above an equal match: a nudge, never an override of how well it matches.

pub fn field(self, text: impl Into<String>, weight: SearchWeight) -> SearchEntry

Find the entry by text too, a match in it ranked as weight.

pub fn with_body(self, body: SearchBody) -> SearchEntry

Find the entry by body too, read in place.

Trait Implementations

impl Clone for SearchEntry

fn clone(&self) -> SearchEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchEntry

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

Formats the value using the given formatter.

impl Default for SearchEntry

fn default() -> SearchEntry

Returns the “default value” for a type.

impl PartialEq for SearchEntry

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