Struct CommandDispatcher 

pub(crate) struct CommandDispatcher<S, R = BrigadierRuntime>
where
    R: CommandRuntime<S>,
{
    id: u64,
    nodes: Vec<CommandNode<S, R>>,
}

Owns a stable arena of command nodes.

Fields

id: u64

nodes: Vec<CommandNode<S, R>>

Implementations

impl<S, R> CommandDispatcher<S, R>

where R: CommandRuntime<S>,

pub(crate) fn new() -> Self

Creates an empty dispatcher containing only its root node.

pub(crate) const fn root(&self) -> NodeId

Returns the stable root node ID.

pub(crate) fn register( &mut self, builder: CommandNodeBuilder<S, R>, ) -> Result<NodeId, RegistrationError>

Registers and merges a literal command tree.

pub(crate) fn parse<'input>( &self, input: &'input str, source: S, ) -> ParseResults<'input, S, R>

Parses input into the best Brigadier command branch.

pub(crate) fn parse_reader<'input>( &self, reader: StringReader<'input>, source: S, ) -> ParseResults<'input, S, R>

Parses from an existing reader while preserving its current cursor.

pub(crate) fn completion_suggestions( &self, parse: &ParseResults<'_, S, R>, ) -> Result<Suggestions, SuggestionError>

Returns completions for the end of a parsed command input.

pub(crate) fn context_chain( &self, parse: ParseResults<'_, S, R>, ) -> Result<ContextChain<S, R>, CommandSyntaxError>

Validates a parse and turns its redirect contexts into executable stages.

pub(crate) fn node(&self, id: NodeId) -> Option<&CommandNode<S, R>>

Returns a node if the ID belongs to this dispatcher.

pub(crate) fn children(&self, id: NodeId) -> Option<&[NodeId]>

Returns a node’s children in registration order.

pub(crate) const fn node_count(&self) -> usize

Returns the number of allocated nodes, including the root.

fn validate_merge( &self, parent: NodeId, incoming: &UnregisteredCommandNode<S, R>, ) -> Result<(), RegistrationError>

fn validate_redirects( &self, node: &UnregisteredCommandNode<S, R>, ) -> Result<(), RegistrationError>

fn apply_merge( &mut self, parent: NodeId, incoming: UnregisteredCommandNode<S, R>, ) -> NodeId

fn find_child(&self, parent: NodeId, name: &str) -> Option<NodeId>

fn parse_nodes<'input>( &self, parent: NodeId, original_reader: StringReader<'input>, context_so_far: ParsedCommandContext<S, R>, ) -> ParseResults<'input, S, R>

fn parse_node( &self, node_id: NodeId, reader: &mut StringReader<'_>, context: &mut ParsedCommandContext<S, R>, ) -> Result<(), CommandSyntaxError>

fn relevant_nodes( &self, parent: NodeId, reader: &StringReader<'_>, ) -> Vec<NodeId>

fn is_better_parse( candidate: &ParseResults<'_, S, R>, current: &ParseResults<'_, S, R>, ) -> bool

Trait Implementations

impl<S, R> Default for CommandDispatcher<S, R>

where R: CommandRuntime<S>,

fn default() -> Self

Returns the “default value” for a type.