Struct Context

pub struct Context {
    pub raw_args: Vec<String>,
    pub args: VecDeque<String>,
    pub common_flags: Vector<Vector<Flag>>,
    pub routes: Vector<String>,
    pub exe_path: String,
    pub common_flags_values: Vector<(String, FlagValue)>,
    pub local_flags_values: Vector<(String, FlagValue)>,
    pub parsing_args: Option<VecDeque<MiddleArg>>,
    pub error_info_list: Vector<ErrorInfo>,
}

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

Fields

raw_args: Vec<String>

raw args

args: VecDeque<String>

non-flag args

common_flags: Vector<Vector<Flag>>

common_flags of its own and inherited

routes: Vector<String>

routes of from root to end

exe_path: String

exe_path (String, not PathBuf)

common_flags_values: Vector<(String, FlagValue)>

storage of result of parsing common flags values

local_flags_values: Vector<(String, FlagValue)>

storage of result of parsing local flags values

parsing_args: Option<VecDeque<MiddleArg>>

On parsing, storage of parsing args. In edge(action), storage of error args

error_info_list: Vector<ErrorInfo>

error inforamation list of parsing

Implementations

impl Context

pub fn new( raw_args: Vec<String>, args: VecDeque<String>, common_flags: Vector<Flag>, routes: Vector<String>, exe_path: String, ) -> Context

Creates a new instance of Context

pub fn with_all_field( raw_args: Vec<String>, args: VecDeque<String>, common_flags: Vector<Vector<Flag>>, exe_path: String, routes: Vector<String>, common_flags_values: Vector<(String, FlagValue)>, local_flags_values: Vector<(String, FlagValue)>, parsing_args: Option<VecDeque<MiddleArg>>, error_info_list: Vector<ErrorInfo>, ) -> Context

Creates a new instance of Context with all options.

pub fn args(self, args: VecDeque<String>) -> Self

Set args

pub fn exe_path(&self) -> &str

Get exe_path as &str

pub fn change_exe_path(self, path: String)

Change exe_path’s value

pub fn push_back_to_parsing_args(&mut self, middle_arg: MiddleArg)

Add(Push back) middle_arg to this context’s parsing_args

pub fn push_front_to_parsing_args(&mut self, middle_arg: MiddleArg)

Shift(Push front) middle_arg to this context’s parsing_args

pub fn take_flag_value_of( &mut self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Takes flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからフラグ値を取得する。Getとは違い、参照ではなくcontextに格納されているもの（格納されていない場合はデフォルト値のコピー）そのものを返す

pub fn take_inputted_flag_value_of( &mut self, flag_name: &str, ) -> Option<FlagValue>

Takes inputted flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからフラグ値を（ユーザによりargに指定（入力）されている場合）取得する。Getとは違い、参照ではなくcontextに格納されているもの（格納されていない場合はNoneを）そのものを返す

pub fn take_local_flag_value_of( &mut self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Takes flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからローカルフラグの値を取得する。Getとは違い、参照ではなくcontextに格納されているもの（格納されていない場合はデフォルト値のコピー）そのものを返す

pub fn take_common_flag_value_of( &mut self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Takes inputted flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからコモンフラグの値を取得する。Getとは違い、参照ではなくcontextに格納されているもの（格納されていない場合はデフォルト値のコピー）そのものを返す

pub fn take_inputted_local_flag_value_of( &mut self, flag_name: &str, ) -> Option<FlagValue>

Takes inputted local flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからローカルフラグ値を（ユーザによりargに指定（入力）されている場合）取得する。Getとは違い、参照ではなくcontextに格納されているものそのもの（格納されていない場合はNone）を返す

pub fn take_inputted_common_flag_value_of( &mut self, flag_name: &str, ) -> Option<FlagValue>

Takes inputted local flag value from context. Different from get, returns flag_value instance own (not reference) that has context. contextからコモンフラグ値を（ユーザによりargに指定（入力）されている場合）取得する。Getとは違い、参照ではなくcontextに格納されているものそのもの（格納されていない場合はNone）を返す

pub fn get_flag_value_of( &self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Gets FlagValue’s clone of the flag matches flag_name from context. contextからフラグ値のcloneを取得する。フラグが設定されていない場合はNoneを返す なお明示的に値が指定されない場合、Bool型のフラグであればFlagValue::Bool(true)とし、String型のフラグであればFlagValue::String(String::new())、それ以外の型のフラグではFlagValue::NoneをSomeで包んで返す

Examples found in repository

examples/single.rs (line 23)

fn act(cmd: Command, c: Context) -> Result<ActionResult, ActionError> {
	let r = c.get_flag_value_of("reverse", &cmd).unwrap();

	println!(
		"{}",
		match r {
			FlagValue::Bool(true) => {
				c.args
					.iter()
					.rev()
					.fold(String::new(), |concated, arg| concated + arg)
			}
			_ => {
				c.args
					.iter()
					.fold(String::new(), |concated, arg| concated + arg)
			}
		}
	);
	Ok(ActionResult::Done)
}

examples/multi.rs (line 40)

fn print_args(current_command: Command, context: Context) -> Result<ActionResult, ActionError> {
	if called_help(&context, &current_command) {
		return call_help(&context, &current_command);
	}
	let r: bool =
		context.get_flag_value_of("reverse", &current_command) == Some(FlagValue::Bool(true));
	let c: bool =
		context.get_flag_value_of("by-char", &current_command) == Some(FlagValue::Bool(true));
	let str = {
		let str = if r && !c {
			context
				.args
				.iter()
				.rev()
				.fold(String::new(), |c, arg| c + arg)
		} else {
			context.args.iter().fold(String::new(), |c, arg| c + arg)
		};
		if c {
			str.chars().rev().collect::<String>()
		} else {
			str
		}
	};

	println!("{str}");

	Ok(ActionResult::Done)
}

fn called_help(c: &Context, cc: &Command) -> bool {
	Some(FlagValue::Bool(true)) == c.get_flag_value_of("help", cc)
}

fn add_command() -> Command {
	Command::new()
		.name("add")
		.alias("a")
		.action(add_action)
		.local_flag(Flag::new_bool("detail").short_alias('d'))
}

fn add_action(cmd: Command, c: Context) -> Result<ActionResult, ActionError> {
	if called_help(&c, &cmd) {
		return call_help(&c, &cmd);
	}
	let f = |(str, sum), num: f64| (format!("{str} {num} +"), sum + num);
	let (mut str, sum): (String, f64) =
		if c.get_flag_value_of("reverse", &cmd) == Some(FlagValue::Bool(true)) {
			c.args
				.iter()
				.rev()
				.filter_map(|arg| arg.parse().ok())
				.fold((String::new(), 0.0), f)
		} else {
			c.args
				.iter()
				.filter_map(|arg| arg.parse().ok())
				.fold((String::new(), 0.0), f)
		};
	str.pop();
	str.pop();

	if c.get_flag_value_of("detail", &cmd).unwrap().is_bool_true() {
		println!("{str} = {sum}");
	} else {
		println!("{sum}");
	}
	Ok(ActionResult::Done)
}

fn sub_command() -> Command {
	Command::new()
		.name("sub")
		.alias("s")
		.action(sub_action)
		.local_flag(Flag::new_bool("sort").short_alias('s'))
}

fn sub_action(cmd: Command, c: Context) -> Result<ActionResult, ActionError> {
	if called_help(&c, &cmd) {
		return call_help(&c, &cmd);
	}
	let f = |(str, sum), (index, num): (usize, f64)| {
		(
			format!("{str} {num} -"),
			if index < 1 { num } else { sum - num },
		)
	};
	let filter_map_f = |arg: &String| arg.parse().ok();
	let (mut str, result): (String, f64) =
		if c.get_flag_value_of("reverse", &cmd) == Some(FlagValue::Bool(true)) {
			c.args
				.iter()
				.rev()
				.filter_map(filter_map_f)
				.enumerate()
				.fold((String::new(), 0.0), f)
		} else if c.get_flag_value_of("sort", &cmd).unwrap().is_bool_true() {
			let mut fvec = c.args.iter().filter_map(filter_map_f).collect::<Vec<f64>>();
			fvec.sort_by(|a, b| a.partial_cmp(b).unwrap());
			fvec
				.iter_mut()
				.enumerate()
				.fold((String::new(), 0.0), |s, (index, fl)| f(s, (index, *fl)))
		} else {
			c.args
				.iter()
				.filter_map(filter_map_f)
				.enumerate()
				.fold((String::new(), 0.0), f)
		};
	str.pop();
	str.pop();

	println!("{str} = {result}");

	Ok(ActionResult::Done)
}

pub fn get_inputted_flag_value_of(&self, flag_name: &str) -> Option<FlagValue>

Gets FlagValue’s clone of the inputted flag matches flag_name from context. contextからユーザから指定された場合のフラグ値のcloneを取得する。ユーザから入力されていない場合はNoneを返す。

pub fn get_common_flag_value_of( &self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Gets FlagValue’s clone of the common flag matches flag_name from context. If it is not defined, Returns None. contextからユーザから指定された場合のコモンフラグ値のcloneを取得する。ユーザから入力されていないが定義されている場合はデフォルト値のクローンを返す。定義もされていない場合はNoneを返す。 なお明示的に値が指定されない場合、Bool型のフラグであればFlagValue::Bool(true)とし、String型のフラグであればFlagValue::String(String::new())、それ以外の型のフラグではFlagValue::NoneをSomeで包んで返す

pub fn get_local_flag_value_of( &self, flag_name: &str, current_command: &Command, ) -> Option<FlagValue>

Gets FlagValue’s clone of the common flag matches flag_name from context. If it is not defined, Returns None. contextからユーザから指定された場合のローカルフラグ値のcloneを取得する。ユーザから入力されていないが定義されている場合はデフォルト値のクローンを返す。定義もされていない場合はNoneを返す。 なお明示的に値が指定されない場合、Bool型のフラグであればFlagValue::Bool(true)とし、String型のフラグであればFlagValue::String(String::new())、それ以外の型のフラグではFlagValue::NoneをSomeで包んで返す

pub fn get_inputted_local_flag_value_of( &self, flag_name: &str, ) -> Option<FlagValue>

Gets the flag value of the local flag matches flag_name if inputted. If it is not defined or not inputted, returns None. flag_nameとnameが一致するローカルフラグがあり、それがユーザからコマンド引数で指定されていた場合、その値のクローンをSomeで包んで返す。flag_nameと一致するnameを持たない場合はローカルフラグ値として保存されていないためNoneを返し、ユーザがコマンド引数で指定していない場合もNoneを返す。

pub fn get_inputted_common_flag_value_of( &self, flag_name: &str, ) -> Option<FlagValue>

Gets the flag value of the common flag whose name matches flag_name. If it is not defined or not inputted, returns None. flag_nameとnameが一致するコモンフラグがあり、それがユーザからコマンド引数で指定されていた場合、その値のクローンをSomeで包んで返す。flag_nameと一致するnameをどのコモンフラグも持たない場合はコモンフラグ値としてそのフラグ値は保存されないためNoneを返し、ユーザがコマンド引数で指定していない場合もNoneを返す。

pub fn is_flag_true(&self, name: &str, current_command: &Command) -> bool

Returns flag has specified name is true flag.

pub fn depth(&self) -> usize

Returns depth of command - root:0

pub fn has_no_error(&self) -> bool

Returns true is self has no error in error_info_list

pub fn num_of_error(&self) -> usize

Returns error info list’s length

pub fn has_error(&self) -> bool

Returns true if error info list’s length is more than one.

pub fn first_error(&self) -> Option<&ErrorInfo>

Returns info of first parse error, or None if it does not exist.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl From<Vec<String>> for Context

fn from(raw_args: Vec<String>) -> Context

Converts to this type from the input type.

impl Run<Context> for Command

fn run(self, c: Context) -> Result<ActionResult, ActionError>

run function