Struct FlagSummary

pub struct FlagSummary { /* private fields */ }

Structure which holds flag summary.

Implementations

impl FlagSummary

Structure implementation.

pub fn with_name<S: Into<String>>( name: S, alias: Option<String>, description: Option<String>, value: Option<String>, default_value: Option<String>, accepts_value: bool, provided: bool, ) -> Self

impl FlagSummary

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 value(&self) -> &Option<String>

Returns value.

pub fn to_value<T>(&self) -> Option<T>

where T: FromStr,

Returns value.

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

Returns default value.

pub fn accepts_value(&self) -> bool

Returns true if the flag has value.

pub fn provided(&self) -> bool

Returns true if the flag has value.

Trait Implementations

impl Clone for FlagSummary

fn clone(&self) -> FlagSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlagSummary

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

Formats the value using the given formatter.

impl PartialEq for FlagSummary

fn eq(&self, other: &FlagSummary) -> 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 FlagSummary