Struct CommandArg

pub struct CommandArg {
    pub name: String,
    pub short: Option<char>,
    pub long: Option<String>,
    pub help: Option<String>,
    pub required: bool,
}

Fields

name: String

The argument name. The argument matches the property name.

short: Option<char>

The short name. -a 1

long: Option<String>

The long name of the argument. –argument=123

help: Option<String>

The help text.

required: bool

True, if the command argument is required.

Implementations

impl CommandArg

pub fn new<S: Into<String>>(name: S) -> Self

pub fn short(self, short: char) -> Self

pub fn long<S: Into<String>>(self, long: S) -> Self

pub fn help<S: Into<String>>(self, help: S) -> Self

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

pub fn as_arg(&self) -> Arg

Trait Implementations

impl Clone for CommandArg

fn clone(&self) -> CommandArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandArg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for CommandArg

fn from(name: &str) -> Self

Converts to this type from the input type.

impl From<CommandArg> for PropertyType

fn from(arg: CommandArg) -> Self

Converts to this type from the input type.

impl From<String> for CommandArg

fn from(name: String) -> Self

Converts to this type from the input type.

impl Serialize for CommandArg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Value> for CommandArg

type Error = InvalidCommandArgDefinition

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.