Enum jargon_args::Key

pub enum Key {
    Dual {
        char: char,
        s_txt: char,
        l_txt: String,
    },
    Long {
        char: char,
        txt: String,
    },
    Short {
        char: char,
        txt: char,
    },
    Sub {
        txt: String,
    },
}

Key

This is the Key enum that represents processable arguments. This has four variants.

Dual

Key::Dual represents ONLY Key::Long and Key::Short in one, they both must start with the same character.

let key: jargon_args::Key = ["-a", "--all"].into();
assert!(key.is_dual())

Long

Key::Long represents a full name argument like --all.

let key: jargon_args::Key = "--all".into();
assert!(key.is_long())

Short

Key::Short represents a single letter argument like -a.

let key: jargon_args::Key = "-a".into();
assert!(key.is_short())

sub

Key::Sub represents a subcommand argument, anything not converted into any other time becomes Key::Sub.

let key: jargon_args::Key = "list".into();
assert!(key.is_sub())

Variants

Dual

Dual

Key::Dual represents ONLY Key::Long and Key::Short in one, they both must start with the same character.

let key: jargon_args::Key = ["-a", "--all"].into();
assert!(key.is_dual())

Fields of Dual

char: char

The character at the beginning of each argument.

s_txt: char

The single character for the short argument.

l_txt: String

The word for the long argument.

Long

Long

Key::Long represents a full name argument like --all.

let key: jargon_args::Key = "--all".into();
assert!(key.is_long())

Fields of Long

char: char

The character at the beginning of the argument.

txt: String

The word for the argument.

Short

Short

Key::Short represents a single letter argument like -a.

let key: jargon_args::Key = "-a".into();
assert!(key.is_short())

Fields of Short

char: char

The character at the beginning of the argument.

txt: char

The character for the argument.

Sub

sub

Key::Sub represents a subcommand argument, anything not converted into any other time becomes Key::Sub.

let key: jargon_args::Key = "list".into();
assert!(key.is_sub())

Fields of Sub

txt: String

The word for the subcommand.

Implementations

impl Key

pub fn char(&self) -> char

Return the char at the beginning of each argument, Key::sub returns \0.

pub fn text(&self) -> String

Returns only the text of each argument as String. --all is all.

pub fn is_dual(&self) -> bool

Returns true if Key is Key::Dual.

pub fn is_long(&self) -> bool

Returns true if Key is Key::Long.

pub fn is_short(&self) -> bool

Returns true if Key is Key::Short.

pub fn is_sub(&self) -> bool

Returns true if Key is Key::Sub.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&'_ str> for Key

fn from(s: &str) -> Self

Performs the conversion.

impl<T: Clone + Into<Key>> From<[T; 2]> for Key

fn from(dk: [T; 2]) -> Self

Performs the conversion.

impl From<String> for Key

fn from(s: String) -> Self

Performs the conversion.

impl Ord for Key

fn cmp(&self, other: &Key) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Key> for Key

fn partial_cmp(&self, other: &Key) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key