Struct SymbolCell

pub(crate) struct SymbolCell(GcHeap<SymbolCellData>);

The allocation of a global symbol. This is shared between threads, so the interned value of a symbol will be the same location no matter which thread interned it. Functions are safe to share between threads because they are marked immutable by SymbolMap::set_func and they can only be replaced atomically. In order to garbage collect the function we need to halt all running threads. This has not been implemented yet.

Tuple Fields

0: GcHeap<SymbolCellData>

Implementations

impl SymbolCell

const NULL: *mut u8 = {0x0 as *mut u8}

const EMTPTY: AtomicPtr<u8>

pub(crate) fn as_bytes(&self) -> &[u8]

fn new_normal(name: &'static str, block: &Block<true>) -> Self

pub(in core) const fn new_static( name: &'static str, ) -> Self

pub(in core) const fn new_static_special( name: &'static str, ) -> Self

fn new_const(name: &'static str, _block: &Block<true>) -> Self

pub(in core) const fn new_static_const( name: &'static str, ) -> Self

fn new_uninterned<const C: bool>(name: &str, bk: &Block<C>) -> Self

pub(crate) fn name(&self) -> &str

pub(crate) fn interned(&self) -> bool

pub(crate) fn is_const(&self) -> bool

Check if the symbol is constant like nil, t, or :keyword

pub(crate) fn has_func(&self) -> bool

fn get(&self) -> Option<Gc<FunctionType<'_>>>

pub(crate) fn func<'a>( &self, _cx: &'a Context<'_>, ) -> Option<Gc<FunctionType<'a>>>

pub(crate) fn follow_indirect<'ob>( &self, cx: &'ob Context<'_>, ) -> Option<Gc<FunctionType<'ob>>>

Follow the chain of symbols to find the function at the end, if any.

pub(in core) unsafe fn set_func( &self, func: Gc<FunctionType<'_>>, ) -> Result<()>

Set the function for this symbol. This function is unsafe to call and requires that the caller:

1. Has marked the entire function as read only
2. Has cloned the function into the SymbolMap block
3. Ensured the symbol is not constant

pub(crate) fn unbind_func(&self)

Trait Implementations

impl Debug for SymbolCell

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

Formats the value using the given formatter.

impl Display for SymbolCell

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

Formats the value using the given formatter.

impl IntoObject for SymbolCell

type Out<'ob> = Symbol<'ob>

fn into_obj<const C: bool>(self, block: &Block<C>) -> Gc<Self::Out<'_>>

impl PartialEq for SymbolCell

fn eq(&self, other: &Self) -> 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 Trace for SymbolCell

fn trace(&self, state: &mut GcState)