Skip to main content

OptionSpec

Struct OptionSpec 

Source
pub struct OptionSpec {
    pub def: OptionDef,
    pub required: bool,
    pub default: Option<String>,
    pub value_completion: Option<ValueProvider>,
}
Expand description

One option as it appears on a specific command: the shared OptionDef shape plus this command’s required-ness, default, and value completer.

Fields§

§def: OptionDef

The shared, parse-defining shape (flag, short, arity, value name, help).

§required: bool

Whether this command requires the option. May differ per command.

§default: Option<String>

Default value applied when the option is absent (value options only).

§value_completion: Option<ValueProvider>

Per-command value completer (closed set, path, dynamic). The completion bridge attaches it to this command’s node. It is not part of the parse shape or the consistency audit, so it may legitimately differ between commands that share the same def.

Implementations§

Source§

impl OptionSpec

Source

pub fn new(def: OptionDef) -> Self

Source

pub fn required(self, yes: bool) -> Self

Source

pub fn default(self, v: impl Into<String>) -> Self

Source

pub fn value_completion(self, provider: ValueProvider) -> Self

Attach a value completer for this option on this command.

Source

pub fn flag(&self) -> &str

The canonical long token, e.g. "--at".

Trait Implementations§

Source§

impl Clone for OptionSpec

Source§

fn clone(&self) -> OptionSpec

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 OptionSpec

Source§

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

Formats the value using the given formatter. Read more

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.

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.