Struct Suggestion 

pub struct Suggestion {
    pub value: String,
    pub label: String,
    pub detail: Option<String>,
    pub subtitle: Option<String>,
    pub icon: Option<Icon>,
    pub person: Option<SuggestionPerson>,
    pub role: RowRole,
    pub matched: Vec<Range<usize>>,
    pub aside: Option<String>,
    pub checked: Option<bool>,
    pub shortcut: Option<String>,
}

One completion offered in the dropdown.

Fields

value: String

The text inserted into the field when this suggestion is accepted.

label: String

The label shown in the dropdown row. Defaults to value via Suggestion::new.

detail: Option<String>

Optional dim secondary text shown right-aligned in the row (e.g. a type or a count).

subtitle: Option<String>

Optional dim line under the label (a page’s address under its title). A list with any such line gives every row two lines.

icon: Option<Icon>

Optional leading glyph.

person: Option<SuggestionPerson>

A participant this row names: painted as their avatar (or, for software acting in the workspace, the agent mark) in place of an icon.

role: RowRole

What the row is: a pickable item (the default), a group’s header or a notice (“No matches”).

matched: Vec<Range<usize>>

Byte ranges of the label the typed query matched, painted bold.

aside: Option<String>

Dim text right after the label on the same line: a handle, a topic, a command’s parameters.

checked: Option<bool>

A state shown in a trailing check column: checked or not. A list with any such row keeps the column on every row.

shortcut: Option<String>

The keys that do what the row does, at its trailing end.

Implementations

impl Suggestion

pub fn is_pickable(&self) -> bool

Whether the row can be armed and accepted.

impl Suggestion

pub fn new(value: impl Into<String>) -> Suggestion

A suggestion whose visible label is its inserted value.

pub fn labelled( value: impl Into<String>, label: impl Into<String>, ) -> Suggestion

A suggestion whose visible label differs from the inserted value.

pub fn with_icon(self, icon: Icon) -> Suggestion

pub fn with_detail(self, detail: impl Into<String>) -> Suggestion

pub fn with_subtitle(self, subtitle: impl Into<String>) -> Suggestion

Show subtitle as a dim line under the label.

pub fn with_person(self, person: SuggestionPerson) -> Suggestion

Lead the row with person’s avatar.

pub fn with_checked(self, checked: bool) -> Suggestion

Show checked in the trailing check column.

pub fn with_shortcut(self, keys: impl Into<String>) -> Suggestion

Show the keys that do what the row does at its end.

Trait Implementations

impl Clone for Suggestion

fn clone(&self) -> Suggestion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Suggestion

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

Formats the value using the given formatter.

impl FloatingRow for Suggestion

type Columns = CheckColumn

What every row of a list shares, computed once per paint.

fn height(&self, metrics: &FloatingMetrics) -> f64

This row’s height in metrics.

fn pickable(&self) -> bool

Whether the pointer and the arrow keys arm it.

fn same(&self, other: &Suggestion) -> bool

Whether self and other are the same row: replacing rows with the same ones then leaves the list scrolled where the person left it. Rows of plain data compare; a row carrying actions always replaces.

fn paint( &self, ctx: &mut PaintCtx<'_>, row: Rect, state: RowState<'_, CheckColumn>, ) -> Option<f64>

Paint the row, returning where its content ends when it is busy: the list puts the progress there.

fn two_line(&self) -> bool

Whether it holds a caption line under its label: a list with one gives every row two lines.

fn busy(&self) -> bool

Whether it is on its way, showing progress at its content’s end.

fn content_width( &self, m: &FloatingMetrics, role: TextRole, text: &mut TextRenderer, theme: &Theme, ) -> f64

What the row needs across, for a list that sizes itself to its rows.

fn columns(rows: &[Suggestion]) -> CheckColumn

What every row of rows shares.

fn cell_count(&self) -> usize

How many cells it offers side by side (an emoji bar), 0 for none.

impl From<SuggestionProps> for Suggestion

fn from(props: SuggestionProps) -> Suggestion

Converts to this type from the input type.

impl PartialEq for Suggestion

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

impl StructuralPartialEq for Suggestion