Struct Arg

pub struct Arg<'a, T: FromStr + Clone> {
    pub name: String,
    pub description: Option<String>,
    pub value: Option<T>,
    pub completor: Option<Completor<'a>>,
    pub default_value: Option<T>,
}

Fields

name: String

description: Option<String>

value: Option<T>

completor: Option<Completor<'a>>

default_value: Option<T>

Implementations

impl<'a, T> Arg<'a, T>

where T: FromStr + Clone,

pub fn name(name: &str) -> Self

pub fn default(self, default: T) -> Self

pub fn description(self, description: &str) -> Self

pub fn get(&self) -> T

pub fn completor<F>(self, completor: F) -> Self

where F: FnMut(&str) -> CliResult<Vec<String>> + 'a,

impl<'a> Arg<'a, String>

pub fn str(name: &str) -> Self

impl<'a> Arg<'a, i32>

pub fn i32(name: &str) -> Self

Trait Implementations

impl<'a, T: Default + FromStr + Clone> Default for Arg<'a, T>

fn default() -> Arg<'a, T>

Returns the “default value” for a type.

impl<'a, T: FromStr + Clone> Input for Arg<'a, T>

fn parse(&mut self, token: &str) -> CliResult<bool>

fn display_name(&self) -> String

fn type_name(&self) -> InputType

fn parsed(&self) -> bool

fn complete(&mut self, value: &str) -> CliResult<Vec<String>>

must not return completions that don’t start with value, otherwise bash breaks

fn is_bool_flag(&self) -> bool

fn description(&self) -> Option<String>

fn has_default(&self) -> bool