Struct cleasy::App

pub struct App {
    pub name: String,
    pub version: String,
    pub author: String,
    pub args: HashMap<String, Vec<String>>,
}

A public struct for your awesome CLI app!

Fields

name: String

version: String

author: String

args: HashMap<String, Vec<String>>

Implementations

impl App

Implementing all methods for your app that give you the freedom to choose what you’d like to do.

pub fn new(name: String, version: String, author: String) -> App

Instantiates the “App” struct.

pub fn arg_was_used(&self, arg: String) -> bool

Checks if “-a” or “–arg” was used.

pub fn add_arg(&mut self, name: String, help: String, data: String)

Adds an argument to the argument pool. If you’d like to accept data for an argument, set the “data” flag to either “true” or “false”.

pub fn get_arg_data(&self, name: String) -> String

Retrieves the command line data for an argument.

pub fn version_is(&self) -> bool

Returns a boolean to tell you whether version info was requested or not.

pub fn help_is(&self) -> bool

Returns a boolean to tell you whether help info was requested or not.

pub fn version(&self) -> String

Returns a string with version info.

pub fn clean_split(&self, subject: String, split_char: String) -> Vec<String>

Helper function to split strings into vectors.

pub fn help(&self) -> String

Returns a string with help info.