Struct climake::Argument

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

An allowed argument for a new CLI

Fields

calls: Vec<CallType>

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

help: Option<&'static str>

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

datatype: DataType

Data this argument accepts

Implementations

impl Argument

pub fn new(
    short_calls: Vec<char>,
    long_calls: Vec<String>,
    help: Option<&'static 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 Clone for Argument

fn clone(&self) -> Argument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl PartialEq<Argument> for Argument

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

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

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

This method tests for !=.

impl StructuralPartialEq for Argument