Struct valence_command::scopes::CommandScopeRegistry

pub struct CommandScopeRegistry { /* private fields */ }

Store the scope graph and provide methods for querying it.

Implementations

impl CommandScopeRegistry

pub fn new() -> Self

Create a new scope registry.

pub fn add_scope<S: Into<String>>(&mut self, scope: S)

Add a scope to the registry.

Example

use valence_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

// creates two nodes. "valence" and "command" with an edge from "valence" to "command"
registry.add_scope("valence.command");
// creates one node. "valence.command.tp" with an edge from "valence.command" to
// "valence.command.tp"
registry.add_scope("valence.command.tp");

// the root node is always present
assert_eq!(registry.scope_count(), 4);

pub fn remove_scope(&mut self, scope: &str)

Remove a scope from the registry.

Example

use valence_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("valence.command");
registry.add_scope("valence.command.tp");

assert_eq!(registry.scope_count(), 4);

registry.remove_scope("valence.command.tp");

assert_eq!(registry.scope_count(), 3);

pub fn grants(&self, scope: &str, other: &str) -> bool

Check if a scope grants another scope.

Example

use valence_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("valence.command");
registry.add_scope("valence.command.tp");

assert!(registry.grants("valence.command", "valence.command.tp")); // command implies tp
assert!(!registry.grants("valence.command.tp", "valence.command")); // tp does not imply command

pub fn any_grants(&self, scopes: &Vec<&str>, other: &str) -> bool

do any of the scopes in the list grant the other scope?

Example

use valence_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("valence.command");
registry.add_scope("valence.command.tp");
registry.add_scope("valence.admin");

assert!(registry.any_grants(
    &vec!["valence.admin", "valence.command"],
    "valence.command.tp"
));

pub fn link(&mut self, scope: &str, other: &str)

Create a link between two scopes so that one implies the other. It will add them if they don’t exist.

Example

use valence_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("valence.command.tp");

registry.link("valence.admin", "valence.command");

assert!(registry.grants("valence.admin", "valence.command"));
assert!(registry.grants("valence.admin", "valence.command.tp"));

pub fn scope_count(&self) -> usize

Get the number of scopes in the registry.

Trait Implementations

impl Clone for CommandScopeRegistry

fn clone(&self) -> CommandScopeRegistry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandScopeRegistry

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

Formats the value using the given formatter.

impl Default for CommandScopeRegistry

fn default() -> Self

Returns the “default value” for a type.

impl Resource for CommandScopeRegistry

where Self: Send + Sync + 'static,