Struct CommandNode

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

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

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

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

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

command: Command<S>

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

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

forks: bool

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

Implementations

impl<S> CommandNode<S>

pub fn literal(&self) -> &Literal

Gets the literal, or panics. You should use match if you’re not certain about the type.

pub fn argument(&self) -> &Argument

Gets the argument, or panics. You should use match if you’re not certain about the type.

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

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

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

pub fn name(&self) -> &str

pub fn usage_text(&self) -> String

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

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

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

Trait Implementations

impl<S> Clone for CommandNode<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for CommandNode<S>

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

Formats the value using the given formatter.

impl<S> Default for CommandNode<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S> Hash for CommandNode<S>

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> PartialEq for CommandNode<S>

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> Eq for CommandNode<S>