Struct CommandContribution 

pub struct CommandContribution {
    pub name: String,
    pub title: Option<String>,
    pub description: String,
    pub entrypoint: String,
    pub args: CommandArgs,
    pub aliases: Vec<String>,
    pub palette: bool,
    pub tui: CommandTuiContribution,
}

A command namespace exposed by a plugin.

Fields

name: String

Command namespace, e.g. sober.

title: Option<String>

Human title for palettes and menus.

description: String

Human description for palettes and menus.

entrypoint: String

Runtime entrypoint. Currently on_command.

args: CommandArgs

Argument contract for the namespace.

aliases: Vec<String>

Additional command names that route to the same entrypoint.

palette: bool

Whether this command appears in the fuzzy palette.

tui: CommandTuiContribution

TUI display hints.

Implementations

impl CommandContribution

pub fn matches(&self, name: &str) -> bool

Does this contribution own name?

pub fn display_title(&self) -> &str

Title to show in palettes and menus.

Trait Implementations

impl Clone for CommandContribution

fn clone(&self) -> CommandContribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandContribution

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandContribution

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CommandContribution

impl PartialEq for CommandContribution

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommandContribution