Enum PermissionRuleContext 

pub enum PermissionRuleContext {
    Global,
    Domain(PermissionDomain),
    World(Identifier),
    Custom {
        key: PermissionContextKey,
        value: PermissionContextValue,
    },
    All(PermissionRuleContexts),
}

Rule-side context in which a permission entry applies.

Variants

Global

Applies in every runtime context.

Domain(PermissionDomain)

Applies within one server domain.

World(Identifier)

Applies within one loaded world.

Custom

Applies when a subsystem-provided key has one value.

Fields

key: PermissionContextKey

Context key owned by Steel or a future plugin.

value: PermissionContextValue

Required active value.

All(PermissionRuleContexts)

Applies when every nested context matches.

Implementations

impl PermissionRuleContext

pub const fn global() -> Self

Returns the global context.

pub fn domain( domain: impl Into<String>, ) -> Result<Self, PermissionRuleContextError>

Creates a domain-scoped rule context.

pub const fn world(world: Identifier) -> Self

Creates a loaded-world rule context.

pub fn custom( key: PermissionContextKey, value: impl Into<String>, ) -> Result<Self, PermissionRuleContextError>

Creates a custom rule context.

Errors

Returns an error when value is empty.

pub fn all( contexts: impl IntoIterator<Item = Self>, ) -> Result<Self, PermissionRuleContextError>

Creates a canonical AND-chain of rule contexts.

Global entries are omitted, nested chains are flattened, and duplicate values are idempotent. Conflicting values for one context key are rejected.

Errors

Returns an error when a built-in or custom key receives multiple values.

pub(super) fn matches(&self, context: &PermissionContext) -> bool

pub(super) fn specificity(&self) -> usize

Trait Implementations

impl Clone for PermissionRuleContext

fn clone(&self) -> PermissionRuleContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PermissionRuleContext

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

Formats the value using the given formatter.

impl Display for PermissionRuleContext

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

Formats the value using the given formatter.

impl Eq for PermissionRuleContext

impl Hash for PermissionRuleContext

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 PartialEq for PermissionRuleContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PermissionRuleContext