Struct Symbol 

pub struct Symbol { /* private fields */ }

A lightweight handle to an interned string.

Symbol is a clonable, comparable, and hashable reference to a string stored inside the interner.

This struct is not copyable sice it has to update reference count atomically but it’s (relatively) cheap to clone.

You can efficiently compare Symbols by value, and resolve them back to string slices when needed.

Example

use asylum;

let sym = asylum::intern("hello");
let string: &str = sym.as_str();

Implementations

impl Symbol

pub fn new(key: &str) -> Self

Creates a new Symbol for the given string slice.

This method is actually the same of calling asylum::intern directly.

Arguments

• key: The string slice to intern.

Example

use asylum::Symbol;

let sym = Symbol::new("hello");

pub fn as_str(&self) -> &str

Returns the interned string slice associated with this Symbol.

Example

use asylum;

let sym = asylum::intern("hello");
assert_eq!(sym.as_str(), "hello");

pub fn count(&self) -> usize

Returns the current reference count for this Symbol.

Useful for debugging or advanced memory management scenarios.

Example

use asylum;

let sym = asylum::intern("hello");
let count = sym.count();
assert_eq!(count, 1);

Trait Implementations

impl AsRef<str> for Symbol

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Symbol

fn clone(&self) -> Self

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 Drop for Symbol

fn drop(&mut self)

Executes the destructor for this type.

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 Eq for Symbol

impl Send for Symbol

impl StructuralPartialEq for Symbol

impl Sync for Symbol