Struct Flag

pub struct Flag { /* private fields */ }

Flag structure which represents command-line option.

Implementations

impl Flag

Flag structure implementation.

pub fn name(&self) -> &String

Returns name.

pub fn alias(&self) -> &Option<String>

Returns alias.

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

Returns description.

pub fn default_value(&self) -> &Option<String>

Returns default value.

pub fn accepts_value(&self) -> bool

Returns true if the flag accepts value.

impl Flag

Flag structure implementation.

pub fn with_name<S: Into<String>>(name: S) -> Self

pub fn with_alias<S: Into<String>>(self, val: S) -> Self

Sets alias name.

pub fn with_description<S: Into<String>>(self, val: S) -> Self

Sets description.

pub fn with_default_value<S: Into<String>>(self, val: S) -> Self

Sets value.

pub fn accept_value(self) -> Self

Sets value.

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Flag

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

Formats the value using the given formatter.

impl PartialEq for Flag

fn eq(&self, other: &Flag) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Flag