Struct CommandEntry 

pub struct CommandEntry {
    pub id: String,
    pub label: String,
    pub description: Option<String>,
    pub badge: Option<String>,
    pub keybinding: Option<String>,
    pub shortcut: Option<Shortcut>,
    pub argument: Option<ArgumentSpec>,
    pub group: Option<String>,
    pub group_total: Option<usize>,
    pub icon: Option<Icon>,
    pub image: Option<AppImage>,
    pub on_select: Option<Arc<dyn Fn(&mut Edits<'_>, &ExId) + Send + Sync>>,
    /* private fields */
}

Fields

id: String

label: String

description: Option<String>

Rendered under the label in PaletteMode::Commands. None → label only.

badge: Option<String>

Short shell-rendered status shown as a trailing pill. Unlike a keybinding it is descriptive and is announced as part of the row.

keybinding: Option<String>

Rendered right-aligned in the row. Purely informational — the palette never binds it.

shortcut: Option<Shortcut>

Preferred semantic form of a shortcut. When present, it is rendered with the host platform’s native command modifier and notation.

argument: Option<ArgumentSpec>

group: Option<String>

Consecutive entries sharing a group render under one header; None joins whatever section precedes it.

group_total: Option<usize>

Real row count for this group before any host-side cap, so a capped section can report what it’s hiding instead of the painted count.

icon: Option<Icon>

image: Option<AppImage>

The application’s own artwork, painted in place of icon when it decodes.

on_select: Option<Arc<dyn Fn(&mut Edits<'_>, &ExId) + Send + Sync>>

Implementations

impl CommandEntry

pub fn new(id: impl Into<String>, label: impl Into<String>) -> CommandEntry

pub fn description(self, d: impl Into<String>) -> CommandEntry

pub fn badge(self, badge: impl Into<String>) -> CommandEntry

pub fn group(self, g: impl Into<String>) -> CommandEntry

pub fn group_total(self, total: usize) -> CommandEntry

pub fn icon(self, icon: Icon) -> CommandEntry

pub fn image(self, image: AppImage) -> CommandEntry

pub fn keybinding(self, k: impl Into<String>) -> CommandEntry

pub fn shortcut(self, shortcut: Shortcut) -> CommandEntry

Adds a platform-formatted shortcut hint. Prefer this to Self::keybinding for commands using the native command modifier.

pub fn keybinding_label(&self, platform: PlatformConventions) -> Option<String>

pub fn with_argument( self, prompt: impl Into<String>, placeholder: impl Into<String>, ) -> CommandEntry

pub fn with_argument_prefill(self, prefill: impl Into<String>) -> CommandEntry

Prefill is fully selected when the argument step opens, so the first keystroke replaces it.

pub fn on_select<F>(self, f: F) -> CommandEntry

where F: Fn(&mut Edits<'_>, &ExId) + Send + Sync + 'static,

pub fn from_flat_action(fa: &FlatAction<'_>) -> CommandEntry

The row id is the flattened composite key, so the host resolves the selection back to a replayable tilo_actions::Action; a ActionInput::Prompted action becomes an argument-collecting row whose text is the action’s primary parameter (its first required one, else its first), as the action’s own prompt reads it.

Trait Implementations

impl Clone for CommandEntry

fn clone(&self) -> CommandEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandEntry

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

Formats the value using the given formatter.