Struct climake::Argument

pub struct Argument<'a> {
    pub calls: Vec<CallType<'a>>,
    pub help: Option<&'a str>,
    pub datatype: DataType,
}

An allowed argument for a new CLI

Fields

calls: Vec<CallType<'a>>

Ways users can call an argument. If this is a length of 0 at compile-time, climake will raise CLIError::NoCalls

help: Option<&'a str>

Help message if any (will display "no help given" if nothing is shown here)

datatype: DataType

Data this argument accepts

Implementations

impl<'a> Argument<'a>

pub fn new(
    short_calls: &[char],
    long_calls: &[&'a str],
    help: Option<&'a str>,
    datatype: DataType
) -> Result<Self, CLIError>

Shortcut method for creating an Argument

pub fn pretty_help(&self) -> String

Creates a pretty, formatted help string for use in help messages by default

Trait Implementations

impl<'a> Clone for Argument<'a>

fn clone(&self) -> Argument<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Argument<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Argument<'a>> for Argument<'a>

fn eq(&self, other: &Argument<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Argument<'a>) -> bool

This method tests for !=.

impl<'a> StructuralPartialEq for Argument<'a>