Struct ArgumentBuilder

pub struct ArgumentBuilder<S> { /* private fields */ }

A node that hasn’t yet been built.

Implementations

impl<S> ArgumentBuilder<S>

A node that isn’t yet built.

pub fn new(value: ArgumentBuilderType) -> Self

pub fn then(self, argument: ArgumentBuilder<S>) -> Self

Continue building this node with a child node.

literal("foo").then(
    literal("bar").executes(|ctx: &CommandContext<()>| 42)
)

pub fn then_built(self, argument: CommandNode<S>) -> Self

Add an already built child node to this node.

You should usually use Self::then instead.

pub fn executes<F>(self, f: F) -> Self

where F: Fn(&CommandContext<S>) -> i32 + Send + Sync + 'static,

Set the command to be executed when this node is reached. If this is not present on a node, it is not a valid command.

literal("foo").executes(|ctx: &CommandContext<()>| 42)

pub fn requires<F>(self, requirement: F) -> Self

where F: Fn(&S) -> bool + Send + Sync + 'static,

Set the requirement for this node to be considered. If this is not present on a node, it is considered to always pass.

literal("foo")
    .requires(|s: &CommandSource| s.opped)
    // ...

pub fn redirect(self, target: Arc<RwLock<CommandNode<S>>>) -> Self

pub fn fork( self, target: Arc<RwLock<CommandNode<S>>>, modifier: Arc<RedirectModifier<S>>, ) -> Self

pub fn forward( self, target: Arc<RwLock<CommandNode<S>>>, modifier: Option<Arc<RedirectModifier<S>>>, fork: bool, ) -> Self

pub fn arguments(&self) -> &CommandNode<S>

pub fn build(self) -> CommandNode<S>

Manually build this node into a CommandNode. You probably don’t need to do this yourself.

Trait Implementations

impl<S: Clone> Clone for ArgumentBuilder<S>

fn clone(&self) -> ArgumentBuilder<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for ArgumentBuilder<S>

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

Formats the value using the given formatter.