Struct CliOption 

pub struct CliOption { /* private fields */ }

A primitive command-line key/value option.

Implementations

impl CliOption

pub const fn new(name: CliOptionName, value: OptionValue) -> CliOption

Creates a CLI option from an already validated name and owned value.

pub fn from_name_value( name: &str, value: impl Into<String>, ) -> Result<CliOption, CliOptionError>

Creates a CLI option from a name and value pair, such as --key value.

Errors

Returns [CliOptionError] when name is not a valid option name.

pub fn from_equals_token(token: &str) -> Result<CliOption, CliOptionError>

Creates a CLI option from a token like --key=value.

Errors

Returns [CliOptionError] when the token does not use --key=value form.

pub const fn name(&self) -> &CliOptionName

Returns the option name.

pub const fn value(&self) -> &OptionValue

Returns the option value.

pub fn to_equals_token(&self) -> String

Returns the --key=value token form.

Trait Implementations

impl Clone for CliOption

fn clone(&self) -> CliOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliOption

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

Formats the value using the given formatter.

impl Hash for CliOption

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CliOption

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

impl StructuralPartialEq for CliOption