azalea_brigadier/builder/
required_argument_builder.rs

1use std::{any::Any, fmt::Debug, sync::Arc};
2
3use super::argument_builder::{ArgumentBuilder, ArgumentBuilderType};
4use crate::{
5    arguments::ArgumentType,
6    exceptions::CommandSyntaxException,
7    string_reader::StringReader,
8    suggestion::{Suggestions, SuggestionsBuilder},
9};
10
11/// An argument node type. The `T` type parameter is the type of the argument,
12/// which can be anything.
13#[derive(Clone)]
14pub struct Argument {
15    pub name: String,
16    parser: Arc<dyn ArgumentType + Send + Sync>,
17}
18impl Argument {
19    pub fn new(name: &str, parser: Arc<dyn ArgumentType + Send + Sync>) -> Self {
20        Self {
21            name: name.to_string(),
22            parser,
23        }
24    }
25
26    pub fn parse(&self, reader: &mut StringReader) -> Result<Arc<dyn Any>, CommandSyntaxException> {
27        self.parser.parse(reader)
28    }
29
30    pub fn list_suggestions(&self, builder: SuggestionsBuilder) -> Suggestions {
31        // TODO: custom suggestions
32        // https://github.com/Mojang/brigadier/blob/master/src/main/java/com/mojang/brigadier/tree/ArgumentCommandNode.java#L71
33
34        self.parser.list_suggestions(builder)
35    }
36
37    pub fn examples(&self) -> Vec<String> {
38        self.parser.examples()
39    }
40}
41
42impl From<Argument> for ArgumentBuilderType {
43    fn from(argument: Argument) -> Self {
44        Self::Argument(argument)
45    }
46}
47
48impl Debug for Argument {
49    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
50        f.debug_struct("Argument")
51            .field("name", &self.name)
52            // .field("parser", &self.parser)
53            .finish()
54    }
55}
56
57/// Shortcut for creating a new argument builder node.
58pub fn argument<S>(
59    name: &str,
60    parser: impl ArgumentType + Send + Sync + 'static,
61) -> ArgumentBuilder<S> {
62    ArgumentBuilder::new(Argument::new(name, Arc::new(parser)).into())
63}