Struct CommandInvocation 

pub struct CommandInvocation {
    pub command: CommandId,
    pub count: Option<Count>,
    pub register: Option<Register>,
    pub range: Option<Range>,
    pub target: Option<Target>,
    pub args: Args,
    pub bang: bool,
}

One call of one command, with every grammar slot vim can fill: the unified call type every front-end produces and execute consumes (DESIGN.md §5.2.1).

A chord ("a3dw), a : line (:%s/a/b/g), a palette pick, a macro replay and a plugin call all become one of these. The dispatcher looks command up in the registry and routes by its CommandKind; each kind reads the slots it understands and ignores the rest (a motion ignores register, an action ignores range and target).

Build with Self::of plus the with_* builders. The value owns everything it holds and borrows nothing, so it can outlive the keystroke that produced it.

Fields

command: CommandId

The command to run. Must have been minted by the registry the invocation is dispatched against, or dispatch fails with CommandError::UnknownCommand.

count: Option<Count>

The count prefix, if one was typed. None and Some(Count(1)) differ: see Count.

register: Option<Register>

The "x register prefix, if one was typed; None means the unnamed register.

range: Option<Range>

An explicit grammar range (:%, :1,5, the Visual selection). When an operator has both, the range wins over Self::target.

target: Option<Target>

What an operator acts on: a motion, text object or range. Unused by other kinds.

args: Args

Command-specific arguments: the char of f{char}, the path of :w path, the parsed fields of :s/…/…/.

bang: bool

Trailing ! on the ex-syntax form (:q!, :w!, :e!). Carried out of the parser into the dispatcher; meaningless for non-ex invocations and ignored by motion / operator / text-object dispatch.

Implementations

impl CommandInvocation

pub fn of(command: CommandId) -> Self

A bare invocation of command: no count, register, range or target; Args::None; no bang.

pub fn with_count(self, count: Count) -> Self

Set the count prefix.

pub fn with_register(self, register: Register) -> Self

Set the register prefix.

pub fn with_range(self, range: Range) -> Self

Set an explicit range.

pub fn with_target(self, target: Target) -> Self

Set the operator target.

pub fn with_args(self, args: Args) -> Self

Replace the arguments.

pub fn with_bang(self, bang: bool) -> Self

Set the trailing-! bit (ex-commands only).

pub fn count_or_default(&self) -> Count

The count, or Count::ONE when none was typed.

pub fn register_or_default(&self) -> Register

The register, or the unnamed register when none was typed.

Trait Implementations

impl Clone for CommandInvocation

fn clone(&self) -> CommandInvocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInvocation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandInvocation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CommandInvocation

fn eq(&self, other: &CommandInvocation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for CommandInvocation

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 CommandInvocation