Struct AtomTable

pub struct AtomTable(/* private fields */);

Opaque handle to the AtomVM atom table

Implementations

impl AtomTable

pub unsafe fn from_raw(ptr: *mut c_void) -> Self

Create an AtomTable from a raw pointer

Safety

The pointer must be valid and point to a real AtomVM atom table

pub fn from_global() -> Self

Create an AtomTable from the global AtomVM instance

This should only be used in production with a running AtomVM. For testing, use MockAtomTable instead.

pub unsafe fn as_raw(&self) -> *mut c_void

Get the raw pointer to the atom table

Safety

The returned pointer should only be used with AtomVM C functions

Trait Implementations

impl AtomTableOps for AtomTable

fn count(&self) -> usize

Get the number of atoms currently in the table

fn get_atom_string(&self, index: AtomIndex) -> Result<AtomRef<'_>, AtomError>

Get atom data by index

fn ensure_atom(&self, atom_data: &[u8]) -> Result<AtomIndex, AtomError>

Ensure an atom exists in the table, creating it if necessary

fn find_atom(&self, atom_data: &[u8]) -> Result<AtomIndex, AtomError>

Ensure an atom exists, but only if it already exists

fn atom_equals(&self, atom_index: AtomIndex, data: &[u8]) -> bool

Check if an atom equals the given byte string

fn compare_atoms(&self, atom1: AtomIndex, atom2: AtomIndex) -> i32

Compare two atoms lexicographically

fn ensure_atoms_bulk( &self, atoms_data: &[u8], count: usize, encoding: EnsureAtomsOpt, ) -> Result<Vec<AtomIndex>, AtomError>

Bulk insert/lookup atoms from encoded atom data

fn ensure_atom_str(&self, atom_str: &str) -> Result<AtomIndex, AtomError>

Ensure an atom exists using a string slice

fn find_atom_str(&self, atom_str: &str) -> Result<AtomIndex, AtomError>

Find an atom using a string slice

fn atom_equals_str(&self, atom_index: AtomIndex, s: &str) -> bool

Check if an atom equals the given string

impl Send for AtomTable

impl Sync for AtomTable