Struct Flag

pub struct Flag<'a> {
    pub short: &'a str,
    pub long: &'a str,
    pub description: &'a str,
}

Fields

short: &'a str

long: &'a str

description: &'a str

Implementations

impl Flag<'_>

Extracts value out of a flag which can have an assignment

Examples

use patchy::flags::Flag;

let my_flag = Flag {
    short: "-r=",
    long: "--remote-name=",
    description: "some flag",
};

let long_version = my_flag.extract_from_arg("--remote-name=abc");
let short_version = my_flag.extract_from_arg("-r=abcdefg");
let invalid = my_flag.extract_from_arg("-m=abcdefg");

assert_eq!(long_version, Some("abc".into()));
assert_eq!(short_version, Some("abcdefg".into()));
assert_eq!(invalid, None);

pub fn is_in(&self, args: &CommandArgs) -> bool

pub fn extract_from_arg(&self, arg: &str) -> Option<String>

Trait Implementations

impl Display for Flag<'_>

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

Formats a flag into a colored format with a description, printable to the terminal