App

Struct App 

Source
pub struct App { /* private fields */ }
Expand description

Command-line application parser

Stack-allocated structure that defines the command-line interface schema. All fields use heap-allocated collections for dynamic argument counts, but the parser itself is deterministic and type-safe.

Implementations§

Source§

impl App

Source

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

Source

pub fn version(self, version: impl Into<String>) -> Self

Source

pub fn about(self, about: impl Into<String>) -> Self

Source

pub fn author(self, author: impl Into<String>) -> Self

Source

pub fn command(self, cmd: Command) -> Self

Source

pub fn arg(self, arg: Arg) -> Self

Source

pub fn group(self, group: ArgGroup) -> Self

Source

pub fn colored_help(self, colored: bool) -> Self

Source

pub fn config_file(self, path: impl Into<String>) -> Self

Enable config file parsing (TOML-like format)

Source

pub fn env_prefix(self, prefix: impl Into<String>) -> Self

Set environment variable prefix for fallback Example: prefix “MYAPP” allows MYAPP_PORT=8080

Source

pub fn generate_completion(&self, shell: Shell) -> String

Generate shell completion script

Source

pub fn parse(self) -> Matches

Auto Trait Implementations§

§

impl Freeze for App

§

impl RefUnwindSafe for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnwindSafe for App

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.