Crate combu

combu is crate for creating cli

Re-exports

pub use action::Action;

pub use action::ActionError;

pub use action::ActionResult;

pub use action::ActionResult::Done;

pub use action::ActionResult::ShowHelpRequest;

pub use command::Command;

pub use flag::Flag;

pub use flag::FlagType;

pub use flag::FlagValue;

pub use hook::Hook;

pub use parser::Parser;

pub use vector::Vector;

Modules

action	action is a module about Action
command	command is a module about command
flag	flag is a module about flag
hook	hook for command execution
parser	parser is a module about command args parser
pub_macros	Macros for combu
vector	vector is a moudle about vector

Macros

action_result	action_result type annotation
check_authors	Checks context has authors flag. If the context has author flag, show authors and exit.
check_copyright	Checks context has license flag. If the context has license flag, show authors and exit.
check_help	Checks context has help flag. If the context has help flag, return ShowHelpRequest.
check_license	Checks context has license flag. If the context has license flag, exec $license_func and return done.
check_preset_flags	Checks context has values of the preset flags.
check_version	Checks context has version flag. If the context has help flag, show version and exit.
crate_authors	Gets crate's authors from cargo.toml.
crate_description	Gets crate's description from cargo.toml.
crate_license	Gets license of crate from cargo.toml.
crate_license_file	Gets license file path of crate from cargo.toml.
crate_name	Gets crate name from cargo.toml.
crate_version	Gets crate's version from cargo.toml.
done	Simple Alias of Ok(Done)
help_req	Simple Alias of Ok(ShowHelpRequest)
include_license_file	Gets license information from cargo.toml.
preset_root	Macro for preset root.
root_from_crate	Macro for convinience to create root command.
v	Creates new Vector.
vector	Creates new Vector.

Structs

Context

Storage information for command execution. This storage raw args, non-flag args, flag values, and etc. コマンドからrunを通ってactionにたどり着くまでの情報およびパース結果を格納する構造体。 フラグの値、たどってきたルートなどを保管。