Struct arret_runtime::boxed::Sym

#[repr(C, align(16))]
pub struct Sym { /* fields omitted */ }

Interned symbol

Symbols are immutable strings typically used as keywords or identifiers.

Implementations

impl Sym

pub fn new(heap: &mut impl AsHeap, value: &str) -> Gc<Sym>

Constructs a new symbol with a specified name

pub fn from_interned_sym(
    heap: &mut impl AsHeap,
    interned: InternedSym
) -> Gc<Sym>

Constructs a new symbol with an interned symbol

pub fn size() -> BoxSize

Returns the box size for symbols

pub fn name<'a>(&'a self, interner: &'a impl AsInterner) -> &'a str

Returns the name of the symbol

interner is required to unintern the name. It must be the same interner used to construct the symbol.

pub fn interned(&self) -> InternedSym

Returns the interned symbol value

Trait Implementations

impl Boxed for Sym

fn as_any_ref(&self) -> Gc<Any>

Casts this value to an Any reference

fn header(&self) -> Header

Returns the header of the box

impl ConstTagged for Sym

const TYPE_TAG: TypeTag

Type tag for values of this type

impl Debug for Sym

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

Formats the value using the given formatter.

impl DistinctTagged for Sym

fn has_tag(type_tag: TypeTag) -> bool

Returns if the passed type tag corresponds to this type

impl Hash for Sym

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Sym> for Sym

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl UniqueTagged for Sym