Struct CommandNode 

#[non_exhaustive]
pub struct CommandNode<S, R = i32> {
    pub value: ArgumentBuilderType<S, R>,
    pub children: BTreeMap<String, Arc<RwLock<CommandNode<S, R>>>>,
    pub literals: HashMap<String, Arc<RwLock<CommandNode<S, R>>>>,
    pub arguments: HashMap<String, Arc<RwLock<CommandNode<S, R>>>>,
    pub command: Command<S, R>,
    pub requirement: Arc<dyn Fn(&S) -> bool + Send + Sync>,
    pub redirect: Option<Arc<RwLock<CommandNode<S, R>>>>,
    pub forks: bool,
    pub modifier: Option<Arc<RedirectModifier<S, R>>>,
}

An ArgumentBuilder that has been built.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

value: ArgumentBuilderType<S, R>

children: BTreeMap<String, Arc<RwLock<CommandNode<S, R>>>>

literals: HashMap<String, Arc<RwLock<CommandNode<S, R>>>>

arguments: HashMap<String, Arc<RwLock<CommandNode<S, R>>>>

command: Command<S, R>

requirement: Arc<dyn Fn(&S) -> bool + Send + Sync>

redirect: Option<Arc<RwLock<CommandNode<S, R>>>>

forks: bool

modifier: Option<Arc<RedirectModifier<S, R>>>

Implementations

impl<S, R> CommandNode<S, R>

pub fn literal(&self) -> &Literal

Returns the value as a literal from this command node, assuming it’s already been checked.

Panics

Will panic if this node is not a literal. Consider using a match statement instead.

pub fn argument(&self) -> &Argument<S, R>

Returns the value as an argument from this command node, assuming it’s already been checked.

Panics

Will panic if this node is not an argument. Consider using a match statement instead.

pub fn get_relevant_nodes( &self, input: &mut StringReader, ) -> Vec<Arc<RwLock<CommandNode<S, R>>>>

pub fn can_use(&self, source: &S) -> bool

pub fn add_child(&mut self, node: &Arc<RwLock<CommandNode<S, R>>>)

pub fn name(&self) -> &str

pub fn usage_text(&self) -> String

pub fn child(&self, name: &str) -> Option<Arc<RwLock<CommandNode<S, R>>>>

pub fn parse_with_context( &self, reader: &mut StringReader, context_builder: &mut CommandContextBuilder<'_, S, R>, ) -> Result<(), CommandSyntaxError>

pub fn list_suggestions( &self, context: CommandContext<S, R>, builder: SuggestionsBuilder, ) -> Suggestions

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, R> Debug for CommandNode<S, R>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<S, R> Hash for CommandNode<S, R>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S, R> PartialEq for CommandNode<S, R>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S, R> Eq for CommandNode<S, R>