Skip to main content

SurfaceArgument

ctl_core::surface

Struct SurfaceArgument 

Source 
pub struct SurfaceArgument {
Show 14 fields
    pub id: String,
    pub index: Option<usize>,
    pub short: Option<char>,
    pub long: Option<String>,
    pub visible_short_aliases: Vec<char>,
    pub short_aliases: Vec<char>,
    pub visible_aliases: Vec<String>,
    pub aliases: Vec<String>,
    pub value_names: Vec<String>,
    pub help: String,
    pub requirement: SurfaceRequirement,
    pub scope: SurfaceScope,
    pub hidden: bool,
    pub takes_values: bool,

}
Expand description

One positional argument or flag in a Surface.

Fields§

§id: String

Clap argument identifier.

§index: Option<usize>

Positional index, absent for options and flags.

§short: Option<char>

Short flag name.

§long: Option<String>

Long flag name without leading dashes.

§visible_short_aliases: Vec<char>

Visible short aliases.

§short_aliases: Vec<char>

All short aliases, including hidden aliases.

§visible_aliases: Vec<String>

Visible long aliases.

§aliases: Vec<String>

All long aliases, including hidden aliases.

§value_names: Vec<String>

Value names shown by Clap.

§help: String

Argument description.

§requirement: SurfaceRequirement

Whether Clap requires the argument.

§scope: SurfaceScope

Whether Clap propagates the argument to subcommands.

§hidden: bool

Whether Clap hides the argument.

§takes_values: bool

Whether the argument action accepts values.

Trait Implementations§

Source§

impl Clone for SurfaceArgument

Source§

fn clone(&self) -> SurfaceArgument

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 SurfaceArgument

Source§

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

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

impl Eq for SurfaceArgument

Source§

impl PartialEq for SurfaceArgument

Source§

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

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 SurfaceArgument

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.