Struct CommandItem 

pub struct CommandItem {
    pub name: String,
    pub kind: CommandKind,
    pub allowed_mode: AllowedMode,
    pub spec: String,
    pub tags: Vec<String>,
}

Runtime command definition to be injected into a ParseContext.

The spec field uses the xparse-style argument specification string (e.g. "m m" for two mandatory args, "s o m" for star + optional + mandatory).

Fields

name: String

Command name without leading backslash

kind: CommandKind

Prefix, infix, or declarative

allowed_mode: AllowedMode

Which content modes this command may appear in

spec: String

xparse-style argument specification string

tags: Vec<String>

Metadata tags for transform-stage filtering

Implementations

impl CommandItem

pub fn new( name: impl Into<String>, kind: CommandKind, allowed_mode: AllowedMode, spec: impl Into<String>, ) -> Self

Create a command item with no tags.

pub fn with_tags<I, T>(self, tags: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Builder method to attach metadata tags.

Trait Implementations

impl Clone for CommandItem

fn clone(&self) -> CommandItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandItem

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

Formats the value using the given formatter.

impl Eq for CommandItem

impl From<CommandItem> for ContextItem

fn from(item: CommandItem) -> Self

Converts to this type from the input type.

impl PartialEq for CommandItem

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