Struct SymbolTable 

pub struct SymbolTable { /* private fields */ }

A per-workspace symbol table.

Symbol IDs are allocated monotonically as a u64; canonical names and alias names are stored in a flat name→id lookup for O(1) resolution.

See symbol-identity-semantics.md § 3 for the design.

Examples

use mimir_core::bind::SymbolTable;
use mimir_core::SymbolKind;

let mut table = SymbolTable::new();
let id = table
    .allocate("alice".into(), SymbolKind::Agent)
    .unwrap();
assert_eq!(table.lookup("alice"), Some(id));

Implementations

impl SymbolTable

pub fn new() -> Self

Construct an empty symbol table.

pub fn allocate( &mut self, name: String, kind: SymbolKind, ) -> Result<SymbolId, BindError>

Allocate a new symbol with the given canonical name and kind.

Errors

• BindError::SymbolRenameConflict if name is already in the table (its existing binding must be used or renamed).

pub fn lookup(&self, name: &str) -> Option<SymbolId>

Resolve a name (canonical or alias) to a SymbolId.

pub fn kind_of(&self, id: SymbolId) -> Option<SymbolKind>

Return the SymbolKind for an already-allocated symbol.

pub fn entry(&self, id: SymbolId) -> Option<&SymbolEntry>

Return the entry for an already-allocated symbol.

pub fn iter_entries( &self, ) -> impl Iterator<Item = (SymbolId, &SymbolEntry)> + '_

Iterate all entries in the table, yielding (SymbolId, &SymbolEntry) pairs. Iteration order is undefined; callers that need stable output should sort on the consuming side.

pub fn add_alias(&mut self, a_name: &str, b_name: &str) -> Result<(), BindError>

Declare an alias — both names resolve to the same symbol.

Both symbols must already be allocated; they must resolve to the same SymbolId already, OR one must not be an alias of the other yet. See symbol-identity-semantics.md § 7.

Errors

• BindError::AliasChainLengthExceeded if adding this alias would push the chain past ALIAS_CHAIN_LIMIT.
• BindError::SymbolRenameConflict if b_name resolves to a different symbol than a_name (merging two distinct symbols is not an alias operation; it must go through rename).

pub fn rename( &mut self, old_name: &str, new_name: &str, ) -> Result<SymbolId, BindError>

Rename a symbol. Old name becomes an alias; new name becomes the canonical.

Errors

• BindError::UnknownSymbol if old_name does not resolve.
• BindError::SymbolRenameConflict if new_name is already bound to a different symbol.
• BindError::AliasChainLengthExceeded if adding the old name as an alias would push the chain past the cap.

pub fn retire(&mut self, name: &str) -> Result<SymbolId, BindError>

Mark a symbol retired. Existing references still resolve; new references through the agent API trigger stale_symbol warnings on read.

Errors

• BindError::UnknownSymbol if name does not resolve.

pub fn unretire(&mut self, name: &str) -> Result<SymbolId, BindError>

Clear a retirement flag. Symmetric with Self::retire.

Errors

• BindError::UnknownSymbol if name does not resolve.

pub fn is_retired(&self, id: SymbolId) -> bool

Whether the symbol is currently retired.

pub fn replay_allocate( &mut self, id: SymbolId, name: String, kind: SymbolKind, ) -> Result<(), BindError>

Replay an SYMBOL_ALLOC canonical record into this table. Unlike Self::allocate the caller supplies the original SymbolId; the next_id monotonic counter is advanced past the replayed ID so future agent allocations stay unique.

Used by crate::store::Store::open to rebuild the table from a durable log.

Errors

• BindError::SymbolRenameConflict if id or name is already bound (log corruption; replay must be strictly monotonic).

pub fn replay_alias( &mut self, id: SymbolId, alias: String, ) -> Result<(), BindError>

Replay an SYMBOL_ALIAS canonical record. Attaches alias as an additional name resolving to id.

Errors

• BindError::UnknownSymbol if id has never been allocated.
• BindError::AliasChainLengthExceeded if adding the alias would exceed ALIAS_CHAIN_LIMIT.

pub fn replay_rename( &mut self, id: SymbolId, new_canonical: String, ) -> Result<(), BindError>

Replay an SYMBOL_RENAME canonical record. The previous canonical name is rotated into aliases.

Errors

• BindError::UnknownSymbol if id has never been allocated.

pub fn replay_retire( &mut self, id: SymbolId, name: String, ) -> Result<(), BindError>

Replay an SYMBOL_RETIRE canonical record. Marks the symbol retired. name is the symbol’s canonical name at retire time; propagated into the error for diagnosability.

Errors

• BindError::UnknownSymbol if id has never been allocated.

Trait Implementations

impl Clone for SymbolTable

fn clone(&self) -> SymbolTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolTable

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

Formats the value using the given formatter.

impl Default for SymbolTable

fn default() -> SymbolTable

Returns the “default value” for a type.

impl PartialEq for SymbolTable

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

impl StructuralPartialEq for SymbolTable