Struct combu::command::Command

pub struct Command {
    pub name: String,
    pub action: Option<Action>,
    pub authors: String,
    pub copyright: String,
    pub description: Option<String>,
    pub usage: String,
    pub l_flags: Vector<Flag>,
    pub c_flags: Vector<Flag>,
    pub alias: Vector<String>,
    pub version: String,
    pub sub: Vector<Command>,
    pub help: Option<HelpFunc>,
}

The struct for command

Fields

name: String

Command name

action: Option<Action>

Command action

authors: String

Command authors

copyright: String

Command copyright

description: Option<String>

Command description

usage: String

Command usage

l_flags: Vector<Flag>

local flags of command

c_flags: Vector<Flag>

common flags of command

alias: Vector<String>

alias for command

version: String

Command version

sub: Vector<Command>

container of sub-command

help: Option<HelpFunc>

custom help fuction

Implementations

impl Command

pub fn new() -> Command

pub fn with_name<T: Into<String>>(name: T) -> Command

pub fn build_new(
    name: String,
    action: Option<Action>,
    authors: String,
    copyright: String,
    description: Option<String>,
    usage: String,
    local_flags: Vector<Flag>,
    common_flags: Vector<Flag>,
    alias: Vector<String>,
    version: String,
    sub: Vector<Command>
) -> Command

pub fn run_with_auto_arg_collect(self)

pub fn single_run(&mut self, raw_args: Vec<String>)

pub fn show_help(&self, c: &Context)

pub fn default_help<'a>(&self, c: &Context) -> String

pub fn name<T: Into<String>>(self, name: T) -> Command

pub fn usage<T: Into<String>>(self, usage: T) -> Self

pub fn action(self, action: Action) -> Self

pub fn authors<T: Into<String>>(self, authors: T) -> Self

pub fn copyright<T: Into<String>>(self, copyright: T) -> Self

pub fn local_flag(self, flag: Flag) -> Self

pub fn common_flag(self, flag: Flag) -> Self

pub fn desctiption<T: Into<String>>(self, description: T) -> Self

pub fn version<T: Into<String>>(self, version: T) -> Self

pub fn sub_command(self, sub_command: Command) -> Self

pub fn alias<T: Into<String>>(self, a: T) -> Self

pub fn help(self, help_function: HelpFunc) -> Self

pub fn is(&self, name_or_alias: &str) -> bool

pub fn take_sub(&mut self, name_or_alias: &str) -> Option<Command>

name_or_aliasに一致するサブコマンドがある場合、保持しているVectorからswap_removeで取り出して返す

pub fn has_sub(&self) -> bool

pub fn derive_route_init_vector(&self) -> Vector<String>

impl Command

pub fn run_from_args(&mut self, raw_args: Vec<String>)

pub fn run_with_context(&mut self, context: Context)

pub fn assign_context(
    &mut self,
    c: Context,
    p: Parser,
    inter_mediate_args: VecDeque<MiddleArg>,
    last: MiddleArg
)

pub fn assign_run(
    &mut self,
    args: VecDeque<String>,
    inter_mediate_args: VecDeque<MiddleArg>,
    p: Parser,
    raw_args: Vec<String>,
    current_path: String
)

pub fn handle_action_result(&self, req: Result<ActionResult, ActionError>)

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Command

fn default() -> Command

Returns the "default value" for a type.

impl From<String> for Command

fn from(name: String) -> Self

Performs the conversion.

impl Run<Context> for Command

fn run(&mut self, c: Context)

impl Run<Vec<String>> for Command

fn run(&mut self, args: Vec<String>)