# clap::arg_enum! [−] [src]

    macro_rules! arg_enum {
        (@as_item $($i:item)*) => { ... };
        (@impls ( $($tts:tt)* ) -> ($e:ident, $($v:ident),+)) => { ... };
        (#[$($m:meta),+] pub enum $e:ident { $($v:ident),+ } ) => { ... };
        (#[$($m:meta),+] enum $e:ident { $($v:ident),+ } ) => { ... };
        (pub enum $e:ident { $($v:ident),+ } ) => { ... };
        (enum $e:ident { $($v:ident),+ } ) => { ... };
    }

Convenience macro to generate more complete enums with variants to be used as a type when parsing arguments. This enum also provides a `variants()` function which can be used to retrieve a `Vec<&'static str>` of the variant names, as well as implementing `FromStr` and `Display` automatically.

NOTE: Case insensitivity is supported for ASCII characters only

NOTE: This macro automatically implements std::str::FromStr and std::fmt::Display

NOTE: These enums support pub (or not) and uses of the #[derive()] traits

# Examples

    arg_enum!{
        #[derive(Debug)]
        pub enum Foo {
            Bar,
            Baz,
            Qux
        }
    }
    // Foo enum can now be used via Foo::Bar, or Foo::Baz, etc
    // and implements std::str::FromStr to use with the value_t! macros
    fn main() {
        let m = App::new("app")
                    .arg_from_usage("<foo> 'the foo'")
                    .get_matches();
        let f = value_t!(m, "foo", Foo).unwrap_or_else(|e| e.exit());

        // Use f like any other Foo variant...
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)