Struct wca::CommandsAggregatorFormer

pub struct CommandsAggregatorFormer<__FormerContext = CommandsAggregator, __FormerEnd = ReturnContainer>
where
    __FormerEnd: ToSuperFormer<CommandsAggregator, __FormerContext>,
{ /* private fields */ }

Object to form CommandsAggregator. If field’s values is not set then default value of the field is set.

For specifying custom default value use attribute default. For example:

use former::Former;
#[ derive( Former ) ]
pub struct Struct1
{
  #[default( 31 ) ]
  field1 : i32,
}

Implementations

impl<__FormerContext, __FormerEnd> CommandsAggregatorFormer<__FormerContext, __FormerEnd>

where __FormerEnd: ToSuperFormer<CommandsAggregator, __FormerContext>,

pub fn form(self) -> CommandsAggregator

Finish setting options and return formed entity.

perform has no effect on method form, but change behavior and returned type of method perform.

pub fn perform(self) -> CommandsAggregator

Finish setting options and call perform on formed entity.

If perform defined then associated method is called and its result returned instead of entity. For example perform() of structure with : #[ perform( fn after1() -> &str > ) returns &str.

pub fn new() -> CommandsAggregatorFormer<CommandsAggregator, ReturnContainer>

Construct new instance of former with default parameters.

pub fn begin(context: Option<__FormerContext>, on_end: __FormerEnd) -> Self

Begin the process of forming. Expects context of forming to return it after forming.

pub fn end(self) -> __FormerContext

End the process of forming returning original context of forming.

pub fn dictionary<Src>(self, src: Src) -> Self

where Src: Into<Dictionary>,

Setter for the ‘dictionary’ field.

pub fn parser<Src>(self, src: Src) -> Self

where Src: Into<Parser>,

Setter for the ‘parser’ field.

pub fn help_generator<Src>(self, src: Src) -> Self

where Src: Into<HelpGeneratorFn>,

Setter for the ‘help_generator’ field.

pub fn help_variants<Src>(self, src: Src) -> Self

where Src: Into<HashSet<HelpVariants>>,

Setter for the ‘help_variants’ field.

pub fn verifier<Src>(self, src: Src) -> Self

where Src: Into<Verifier>,

Setter for the ‘verifier’ field.

pub fn callback_fn<Src>(self, src: Src) -> Self

where Src: Into<CommandsAggregatorCallback>,

Setter for the ‘callback_fn’ field.

impl<Context, End> CommandsAggregatorFormer<Context, End>

where End: ToSuperFormer<CommandsAggregator, Context>,

pub fn command<IntoName>( self, name: IntoName ) -> CommandFormer<Self, impl ToSuperFormer<Command, Self>>

where IntoName: Into<String>,

Creates a command in the command chain.

Arguments

• name - The name of the command.

impl CommandsAggregatorFormer

pub fn help<HelpFunction>(self, func: HelpFunction) -> Self

where HelpFunction: Fn(&Dictionary, Option<&Command>) -> String + 'static,

Setter for help content generator

use wca::CommandsAggregator;

let ca = CommandsAggregator::former()
// ...
.help( | grammar, command | format!( "Replaced help content" ) )
.perform();

ca.perform( ".help" )?;

pub fn callback<Callback>(self, callback: Callback) -> Self

where Callback: Fn(&str, &Program<VerifiedCommand>) + 'static,

Set callback function that will be executed after validation state

use wca::CommandsAggregator;

let ca = CommandsAggregator::former()
// ...
.callback( | _input, _program | println!( "Program is valid" ) )
.perform();

// prints the "Program is valid" and after executes the program
ca.perform( ".help" )?;