Enum Flag 

pub enum Flag<S: AsRef<str> = String> {
    Word(S),
    Blob(S),
}

Command Parameter: A flag passed to the command

Flags in duat differ from those of UNIX like operating system commands, since a flag can show up anywhere, not just before some standalone -- which separates flags and “not flags”. Instead, what determines if an argument starting with -- or - is a flag or not is if said argument is quoted:

mycmd --this-is-a-flag "--this-is not a flag" -blobflag -- --flag

Variants

Word(S)

A word flag is prefixed by -- and represents only one thing

Examples of this are the --cfg and --cfg-manifest, which are used by the edit and open commands to open Duat configuration files.

Blob(S)

A blob flag is prefixed by - and represents one thing per char

An example, coming from UNIX like operating systems is rm -rf, witch will forcefully (f) remove files recursively (r).

Implementations

impl<S: AsRef<str>> Flag<S>

pub fn as_word(self) -> Result<S, Text>

Returns Ok only if the Flag is of type Flag::Word

pub fn is_word(&self, word: &str) -> bool

Returns true if this Flag is a Flag::Word(word)

pub fn as_blob(self) -> Result<S, Text>

Returns Ok only if the Flag is of type Flag::Blob

pub fn has_blob(&self, blob: &str) -> bool

Returns true if this Flag is a Flag::Blob with all characters in blob

pub fn word_from_list<const N: usize>( self, list: [&str; N], ) -> Result<&str, Text>

Returns an Err if the Flag is a blob or doesn’t belong on the list

this is useful for quickly matching against a fixed list of possible words, while having a “catchall _ => {}, which will never match.

pub fn as_str(&self) -> Flag<&str>

Returns a new Flag<&str>

This is particularly useful in pattern matching.

Trait Implementations

impl Parameter for Flag

fn new(_: &Pass, args: &mut Args<'_>) -> Result<(Self, Option<FormId>), Text>

Tries to consume arguments until forming a parameter

fn arg_name() -> Text

A short descriptive name