pub struct CommandScopeRegistry { /* private fields */ }
Expand description

Store the scope graph and provide methods for querying it.

Implementations§

source§

impl CommandScopeRegistry

source

pub fn new() -> Self

Create a new scope registry.

source

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

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);
source

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);
source

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
source

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"
));

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"));
source

pub fn scope_count(&self) -> usize

Get the number of scopes in the registry.

Trait Implementations§

source§

impl Clone for CommandScopeRegistry

source§

fn clone(&self) -> CommandScopeRegistry

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CommandScopeRegistry

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for CommandScopeRegistry

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Resource for CommandScopeRegistry
where Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromWorld for T
where T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World].
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

§

fn clone_type_data(&self) -> Box<dyn TypeData>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more