Struct Symbol 

pub struct Symbol {
    pub namespace: Option<Arc<str>>,
    pub name: Arc<str>,
}

An optionally namespaced name for a runtime entity.

The kernel defines the symbol contract; it is the name that appears in Expr forms, refs, and registry keys. Names are reference-counted (Arc<str>), not interned: cloning is cheap, but there is no global dedup table, so two symbols with equal text are distinct allocations that merely compare equal.

Name grammar

A symbol is a namespace (optional) plus a bare name. Bare names are treated as opaque text by the kernel; the qualified rendering is namespace/name (or just name when unqualified). as_qualified_str is therefore not injective when a component contains /: Symbol::new("a/b") and Symbol::qualified("a", "b") render identically yet are unequal. Construct symbols at untrusted boundaries with Symbol::checked, which rejects /, NUL, and control characters so the qualified rendering stays unambiguous.

Examples

let plain = Symbol::new("car");
assert_eq!(plain.as_qualified_str(), "car");

let qualified = Symbol::qualified("core", "Bool");
assert_eq!(qualified.as_qualified_str(), "core/Bool");

Fields

namespace: Option<Arc<str>>

The optional namespace component (the part before /).

name: Arc<str>

The bare name component.

Implementations

impl Symbol

pub fn new(name: impl Into<Arc<str>>) -> Self

Creates an unqualified symbol with no namespace.

pub fn checked(name: impl Into<Arc<str>>) -> Result<Self, SymbolError>

Creates an unqualified symbol after validating the name.

Unlike Symbol::new, this rejects names that would make the qualified rendering ambiguous or unprintable: names containing / (the namespace separator), NUL, or any other control character. Codecs and other untrusted boundaries should adopt this constructor; trusted kernel call sites may keep using the infallible Symbol::new.

pub fn qualified( namespace: impl Into<Arc<str>>, name: impl Into<Arc<str>>, ) -> Self

Creates a symbol qualified by namespace.

pub fn as_qualified_str(&self) -> String

Renders the symbol as namespace/name, or just name when unqualified.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

impl Hash for Symbol

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 Symbol

fn cmp(&self, other: &Symbol) -> 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 Symbol

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

fn partial_cmp(&self, other: &Symbol) -> 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 StructuralPartialEq for Symbol