Struct Scope 

pub struct Scope { /* private fields */ }

A position in the visibility tree.

Segments are opaque to Mumble Server Runtime: a flavor puts whatever it wants in them (a game id, a team id). Two scopes are equal when their paths are equal, so this derives Ord for use as a map key and for canonicalizing a ScopeSet.

Implementations

impl Scope

pub const ROOT: Scope

The root scope: what everyone who observes anything at all can see.

pub fn child(self, segment: u32) -> Option<Scope>

Extend this scope by one segment.

This is the only constructor beyond Scope::ROOT, and it can only ever narrow. That is what makes an incoherent view inexpressible rather than merely invalid: there is no free scope parameter anywhere in the builder.

Returns None past MAX_DEPTH. Saturating instead would silently give the child its parent’s scope, widening what the flavor asked to restrict - a privacy leak dressed as a rounding error. Refusing propagates into a build error that keeps the previous view (guide 11.7).

pub fn depth(self) -> usize

How many segments this scope carries. The root has zero.

pub fn is_prefix_of(self, other: Scope) -> bool

Whether this scope is a prefix of other (a scope is its own prefix).

pub fn comparable(self, other: Scope) -> bool

Whether either scope is a prefix of the other.

Reflexive and symmetric by construction. Deliberately not transitive: /g7 is comparable to both /g7/t2 and /g7/t3, which are not comparable to each other. That is the point, not a defect.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Scope

Returns the “default value” for a type.

impl Hash for Scope

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 Ord for Scope

fn cmp(&self, other: &Scope) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Scope

fn eq(&self, other: &Scope) -> 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 PartialOrd for Scope

fn partial_cmp(&self, other: &Scope) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Scope

impl Eq for Scope

impl StructuralPartialEq for Scope