Struct nvim_oxi::api::types::CommandInfos

#[non_exhaustive]
pub struct CommandInfos {

    pub addr: Option<CommandAddr>,
    pub bang: bool,
    pub bar: bool,
    pub callback: Option<Function<CommandArgs, ()>>,
    pub complete: Option<String>,
    pub complete_arg: Option<String>,
    pub count: Option<u32>,
    pub definition: Option<String>,
    pub keepscript: bool,
    pub name: String,
    pub nargs: CommandNArgs,
    pub range: Option<CommandRange>,
    pub register: bool,
    pub script_id: i32,
}

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.

addr: Option<CommandAddr>

TODO: docs

bang: bool

Whether the command can take a ! modifier.

bar: bool

Whether the command can be followed by a | and another command.

callback: Option<Function<CommandArgs, ()>>

Callback triggered by the command.

complete: Option<String>

Command complletion strategy.

complete_arg: Option<String>

TODO: docs

count: Option<u32>

TODO: docs

definition: Option<String>

TODO: docs

keepscript: bool

Whether to use the invocation location as opposed to the definition location in verbose messages.

name: String

The command name.

nargs: CommandNArgs

The number of arguments the command can take.

range: Option<CommandRange>

TODO: docs

register: bool

Whether the firrst argument to the command can be an optional register name (like :del, :put or :yank).

script_id: i32

TODO: docs

Trait Implementations

impl Clone for CommandInfos

fn clone(&self) -> CommandInfos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandInfos

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandInfos

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CommandInfos, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromObject for CommandInfos

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

impl Hash for CommandInfos

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<CommandInfos> for CommandInfos

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommandInfos

impl StructuralEq for CommandInfos

impl StructuralPartialEq for CommandInfos