Struct CommandArgs

#[non_exhaustive]
pub struct CommandArgs {
    pub args: Option<String>,
    pub bang: bool,
    pub count: Option<u32>,
    pub fargs: Vec<String>,
    pub line1: usize,
    pub line2: usize,
    pub mods: Option<String>,
    pub range: u8,
    pub register: Option<String>,
    pub smods: CommandModifiers,
}

Arguments passed to functions executed by commands.

See Buffer::create_user_command to create a buffer-local command or create_user_command to create a global one.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

args: Option<String>

The arguments passed to the command, if any.

bang: bool

Whether the command was executed with a ! modifier.

count: Option<u32>

The count supplied by <count>, if any.

fargs: Vec<String>

The arguments passed to the command split by unescaped whitespace.

line1: usize

The starting line of the command range.

line2: usize

The final line of the command range.

mods: Option<String>

Command modifiers, if any.

range: u8

The number of items in the command range.

register: Option<String>

The optional register, if specified.

smods: CommandModifiers

Command modifiers in a more structured format.

Trait Implementations

impl Clone for CommandArgs

fn clone(&self) -> CommandArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromObject for CommandArgs

fn from_object(obj: Object) -> Result<Self, Error>

impl Hash for CommandArgs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CommandArgs

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

unsafe fn pop(lstate: *mut State) -> Result<Self, Error>

Pops the value at the top of the stack.

impl Eq for CommandArgs

impl StructuralPartialEq for CommandArgs