Struct Item 

pub struct Item {
    pub kind: &'static str,
    pub id: String,
    pub fields: Vec<(&'static str, String)>,
    pub found_by: Vec<(String, SearchWeight)>,
    pub body: Option<SearchBody>,
    pub payload: Option<Arc<dyn Any + Send + Sync>>,
}

One item of a resource type, as search and views read it: its type, its id, and its fields by key. A field may hold several values (a song by two artists). A remote source attaches what it fetched (payload), so the app can make the item playable or openable before anything is stored.

Fields

kind: &'static str

id: String

fields: Vec<(&'static str, String)>

found_by: Vec<(String, SearchWeight)>

More text the item is found by but that no presentation shows, each ranked by its own weight: a book’s subject, a note on a highlight.

body: Option<SearchBody>

Long prose the item is found by (a book’s chapter), read in place. A match in a segment the body locates is a hit of its own: its location, listed under the location’s own type.

payload: Option<Arc<dyn Any + Send + Sync>>

Implementations

impl Item

pub fn new(kind: &'static str, id: impl Into<String>) -> Self

pub fn from_entry(kinds: &[KindDecl], entry: &SearchEntry) -> Option<Self>

The item an app’s search entry describes, typed by the declaration whose plural names the entry’s group (an entry without a group is the first type’s): its title and subtitle fill the type’s title and subtitle fields, its facets the filter fields of the same keys, and its fields and body are what it is found by. The entry rides along as the payload, so opening the item invokes what the entry does. None when no type is the entry’s or it addresses nothing.

pub fn with(self, key: &'static str, value: impl Into<String>) -> Self

Add value to the field key; an empty value adds nothing.

pub fn flag(self, key: &'static str, on: bool) -> Self

Set the toggle field key on, when on.

pub fn payload(self, payload: Arc<dyn Any + Send + Sync>) -> Self

Attach what a remote source fetched.

pub fn value<'a>(&'a self, key: &'a str) -> Option<&'a str>

The first value of the field key.

pub fn values<'a>(&'a self, key: &'a str) -> impl Iterator<Item = &'a str> + 'a

Every value of the field key.

pub fn is_on(&self, key: &str) -> bool

Whether the toggle field key is on.

pub fn key(&self) -> (&'static str, &str)

What identifies the item across sources: its type and id.

pub fn entry(&self) -> Option<&SearchEntry>

The search entry the item was made from (Item::from_entry).

pub fn payload_as<T: Any + Send + Sync>(&self) -> Option<&T>

The payload a remote source attached, as T.

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Item

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

Formats the value using the given formatter.

impl PartialEq for Item

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