Struct wca::CommandFormer

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

Object to form Command. 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> CommandFormer<__FormerContext, __FormerEnd>

where __FormerEnd: ToSuperFormer<Command, __FormerContext>,

pub fn form(self) -> Command

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) -> Command

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() -> CommandFormer<Command, 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 hint<Src>(self, src: Src) -> Self

where Src: Into<String>,

Setter for the ‘hint’ field.

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

where Src: Into<String>,

Setter for the ‘hint’ field.

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

where Src: Into<String>,

Setter for the ‘long_hint’ field.

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

where Src: Into<String>,

Setter for the ‘long_hint’ field.

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

where Src: Into<String>,

Setter for the ‘phrase’ field.

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

where Src: Into<Vec<ValueDescription>>,

Setter for the ‘subjects’ field.

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

where Src: Into<HashMap<String, ValueDescription>>,

Setter for the ‘properties’ field.

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

where Src: Into<HashMap<String, String>>,

Setter for the ‘properties_aliases’ field.

impl<Context, End> CommandFormer<Context, End>

where End: ToSuperFormer<Command, Context>,

pub fn property_alias<S: Into<String>>(self, key: S, alias: S) -> Self

Setter for separate properties aliases.

pub fn routine<I, R, F: Into<Handler<I, R>>>(self, f: F) -> Self

where Routine: From<Handler<I, R>>,

Sets the command routine.

You can set the following types of command routines:

• fn(): A command routine without any argument or property.
• fn(args): A command routine with arguments.
• fn(props): A command routine with properties.
• fn(args, props): A command routine with arguments and properties.
• fn(context): A command routine with a context.
• fn(context, args): A command routine with a context and arguments.
• fn(context, props): A command routine with a context and properties.
• fn(context, args, props): A command routine with a context, arguments, and properties.

Type Parameters

• I: The input type for the handler function.
• R: The return type for the handler function.
• F: The function type that can be converted into a handler.

Parameters

• self: The current CommandFormer instance. This instance will be consumed by this method.
• f: The function that will be set as the command routine.

Returns

Returns the CommandFormer instance with the new command routine set.

impl<Context, End> CommandFormer<Context, End>

where End: ToSuperFormer<Command, Context>,

pub fn subject( self ) -> ValueDescriptionFormer<Self, impl ToSuperFormer<ValueDescription, Self>>

Implements the subject method for a value.

This method allows chaining, where subject is the current value and ValueDescription is the super-former. It returns a ValueDescriptionFormer which can be used to further build the super-former.

pub fn property<IntoName>( self, name: IntoName ) -> PropertyDescriptionFormer<Self, impl ToSuperFormer<PropertyDescription, Self>>

where IntoName: Into<String>,

Sets the name and other properties of the current property.

This method takes ownership of self and the name of the property as input. It returns a PropertyDescriptionFormer instance that allows chaining of different property descriptions.

Arguments

• name - The name of the property. It should implement the Into< String > trait.