Struct CommandNodeBuilder 

pub(crate) struct CommandNodeBuilder<S, R = BrigadierRuntime>
where
    R: CommandRuntime<S>,
{
    data: CommandNodeData<R::Argument>,
    children: Vec<Self>,
    executor: Option<Arc<R::Executor>>,
    requirement: CommandRequirement<S>,
    execution_requirement: CommandRequirement<S>,
    redirect: Option<CommandRedirect<S, R>>,
}

Builds one literal or argument command node and its descendants.

Fields

data: CommandNodeData<R::Argument>

children: Vec<Self>

executor: Option<Arc<R::Executor>>

requirement: CommandRequirement<S>

execution_requirement: CommandRequirement<S>

redirect: Option<CommandRedirect<S, R>>

Implementations

impl<S, R> CommandNodeBuilder<S, R>

where R: CommandRuntime<S>,

pub(crate) fn literal(name: impl Into<Box<str>>) -> Self

Creates a literal for this runtime model.

pub(crate) fn argument( name: impl Into<Box<str>>, argument_type: R::Argument, ) -> Self

Creates an argument for this runtime model.

pub(crate) fn literal_name(&self) -> Option<&str>

Returns this node’s literal name, or None for an argument node.

pub(crate) fn with_literal_name(self, name: impl Into<Box<str>>) -> Option<Self>

Replaces this node’s literal name, returning None for an argument node.

pub(crate) fn then(self, child: Self) -> Self

Adds a child while preserving registration order.

pub(crate) fn executes_with_executor(self, executor: Arc<R::Executor>) -> Self

Attaches an executor payload without interpreting it.

pub(crate) fn requires(self, requirement: CommandRequirement<S>) -> Self

Replaces the allow-all requirement with requirement.

pub(crate) fn also_requires(self, requirement: CommandRequirement<S>) -> Self

where S: 'static,

Adds a requirement while preserving any predicate already on this node.

pub(crate) fn also_requires_execution( self, requirement: CommandRequirement<S>, ) -> Self

where S: 'static,

Adds a requirement that applies only when this node’s executor is selected.

pub(crate) fn literal_path_match_count(&self, path: &[Box<str>]) -> usize

Returns the number of occurrences of one literal path below this node.

Argument nodes do not consume path segments.

pub(crate) fn apply_scoped_requirements( &mut self, scope_paths: &[Vec<Box<str>>], requirements_for: impl FnMut(Option<usize>, &[usize]) -> CommandRequirementRoute<S>, )

where S: 'static,

Applies independently scoped requirements using literal-only paths.

A descendant scope may traverse its ancestors, but it cannot execute an ancestor unless the route’s governing requirement also permits it.

fn apply_scoped_requirements_inner<F>( &mut self, inherited_scope: Option<usize>, active: &[ActiveRequirementScope<'_>], parent_route: Option<&RequirementRouteKey>, cache: &mut Vec<(RequirementRouteKey, CommandRequirementRoute<S>)>, requirements_for: &mut F, )

where S: 'static, F: FnMut(Option<usize>, &[usize]) -> CommandRequirementRoute<S>,

pub(crate) fn redirects(self, target: impl Into<CommandRedirectTarget>) -> Self

Redirects parsing to an existing node without transforming the source.

pub(crate) fn redirects_with_modifier( self, target: impl Into<CommandRedirectTarget>, modifier: Arc<R::Modifier>, forks: bool, ) -> Self

Redirects with an opaque runtime modifier payload.

pub(super) fn normalize( self, ) -> Result<UnregisteredCommandNode<S, R>, RegistrationError>

impl<S> CommandNodeBuilder<S, BrigadierRuntime>

pub(crate) fn executes( self, executor: impl Fn(&CommandContext<S>) -> Result<i32, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Attaches a standard synchronous command callback.

pub(crate) fn redirects_with( self, target: NodeId, modifier: impl Fn(&CommandContext<S>) -> Result<S, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Redirects parsing and transforms the source once before continuing.

pub(crate) fn forks( self, target: NodeId, modifier: impl Fn(&CommandContext<S>) -> Result<Vec<S>, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Redirects parsing and expands one source into zero or more sources.

impl<S> CommandNodeBuilder<S, SteelCommandRuntime>

where S: ExecutionCommandSource,

pub(crate) fn executes( self, executor: impl Fn(&CommandContext<S, SteelCommandRuntime>) -> Result<i32, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Attaches an ordinary synchronous executor.

pub(crate) fn executes_suspended<T>( self, executor: impl Fn(&CommandContext<S, SteelCommandRuntime>) -> Result<T, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

where T: CommandResultSuspension,

Attaches an ordinary executor whose command result is produced across ticks.

pub(crate) fn executes_custom( self, executor: impl CustomCommandExecutor<S> + 'static, ) -> Self

Attaches an internal executor with frame and queue control.

pub(crate) fn redirects_with( self, target: impl Into<CommandRedirectTarget>, modifier: impl Fn(&CommandContext<S, SteelCommandRuntime>) -> Result<S, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Redirects parsing and transforms the source once before continuing.

pub(crate) fn forks( self, target: impl Into<CommandRedirectTarget>, modifier: impl Fn(&CommandContext<S, SteelCommandRuntime>) -> Result<Vec<S>, CommandSyntaxError> + Send + Sync + 'static, ) -> Self

Redirects parsing and expands one source into zero or more sources.

pub(crate) fn redirects_custom( self, target: impl Into<CommandRedirectTarget>, modifier: impl CustomModifierExecutor<S> + 'static, forks: bool, ) -> Self

Redirects with an internal modifier that controls frames or queued work.

Trait Implementations

impl<S, R> Clone for CommandNodeBuilder<S, R>

where R: CommandRuntime<S>, R::Argument: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.