Skip to main content

CommandLineSlot

Enum CommandLineSlot 

Source
pub enum CommandLineSlot {
    CommandName {
        prefix: String,
        replace_start: usize,
    },
    Arg {
        command_name: String,
        arg_index: usize,
        arg_spec: ArgSpec,
        prefix: String,
        replace_start: usize,
    },
    BeyondSchema {
        command_name: String,
    },
    DelimiterBody {
        command_name: String,
        body: String,
    },
    UnknownCommand {
        word: String,
        replace_start: usize,
    },
    Empty,
}
Expand description

What the cursor on the : line is pointing at.

Variants§

§

CommandName

Cursor is in (or right after) the command name. The completion source is conventionally gen:commands.

Fields

§prefix: String

Partial text typed so far for the command name.

§replace_start: usize

Byte offset within the cmdline where the prefix begins (so the host can replace [replace_start, cursor) when the user accepts a candidate).

§

Arg

Cursor is in the N-th positional arg of the resolved command. arg_spec is the schema entry; command_name is the canonical registry name (so the host can re-look-up if it needs to).

Fields

§command_name: String
§arg_index: usize
§arg_spec: ArgSpec
§prefix: String
§replace_start: usize
§

BeyondSchema

Cursor is past the schema’s declared args (e.g. extra trailing whitespace on a no-arg command). No completion.

Fields

§command_name: String
§

DelimiterBody

Cursor is on a delimiter-syntax command body (:s/pattern/replacement/flags, :g/pattern/body). v1 returns this without slot specifics; the cmdline parser may special-case if it wants to (e.g. complete commands inside :g body). Default: no completion.

Fields

§command_name: String
§body: String
§

UnknownCommand

Couldn’t resolve the command word to a registered command. No completion possible (we don’t know the schema).

Fields

§word: String
§replace_start: usize
§

Empty

Empty cmdline. Treated as command-name slot with empty prefix.

Implementations§

Source§

impl CommandLineSlot

Source

pub fn prefix(&self) -> &str

Convenience: get the prefix the matcher should run against.

Source

pub fn replace_start(&self) -> Option<usize>

Trait Implementations§

Source§

impl Clone for CommandLineSlot

Source§

fn clone(&self) -> CommandLineSlot

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandLineSlot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for CommandLineSlot

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CommandLineSlot

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more