Skip to main content

ArgValue

Enum ArgValue 

Source
pub enum ArgValue {
    String(String),
    Char(char),
    Bool(bool),
    Int(i64),
    Pattern(String),
    Chord(String),
    Invocation(Box<CommandInvocation>),
    Raw(String),
}
Expand description

One argument’s typed value. The variants mirror ArgKind one-for-one.

Variants§

§

String(String)

Free-form text.

§

Char(char)

A single character.

§

Bool(bool)

A flag (e.g. a transient switch).

§

Int(i64)

A signed integer.

§

Pattern(String)

A pattern – regex when v1 grows regex; literal substring today.

§

Chord(String)

A keyboard chord in canonical notation (<C-c>, <Esc>, gg, <C-S-x>). Stored as a string so the value layer doesn’t need to know about crossterm / KeyEvent; the UI captures raw key events and renders them via format_chord before the value reaches here. Used by :describe-key and (later) :map, :nnoremap, etc.

§

Invocation(Box<CommandInvocation>)

A nested invocation. Used by :g/.../body where the body is a command in its own right; the parser front-end produces a CommandInvocation and the host dispatches it per match. Boxed because Args lives inside CommandInvocation.

§

Raw(String)

Raw text whose parsing was deferred. v1 uses this for :g’s body string (re-parsed per line by the host) until we promote body to a parsed Invocation.

Implementations§

Source§

impl ArgValue

Source

pub fn kind(&self) -> ArgKind

The ArgKind tag for this value (ArgValue::Invocation maps to ArgKind::Body; every other variant to its namesake).

Source

pub fn as_str(&self) -> Option<&str>

Borrow the text of any string-shaped value (String, Pattern, Chord, Raw); None for Char, Bool, Int, Invocation.

Source

pub fn as_bool(&self) -> Option<bool>

The flag of an ArgValue::Bool; None for every other variant (no truthiness coercion).

Source

pub fn as_invocation(&self) -> Option<&CommandInvocation>

Extract a parsed sub-invocation. Used by :g’s body slot to pull the pre-parsed CommandInvocation out at apply time.

Trait Implementations§

Source§

impl Clone for ArgValue

Source§

fn clone(&self) -> ArgValue

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 ArgValue

Source§

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

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

impl<'de> Deserialize<'de> for ArgValue

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ArgValue

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for ArgValue

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ArgValue

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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