Struct DictStore 

pub struct DictStore {
    pub entities: EntityTable,
    /* private fields */
}

Storage for all PostScript dictionaries.

The entity table maps EntityId → index into dicts. For Phase 2 this is a 1:1 mapping (entity N → dicts[N]), but the indirection enables save_level tracking and future COW.

Fields

entities: EntityTable

Implementations

impl DictStore

pub fn new() -> Self

pub fn dict_slots(&self) -> usize

Allocate a new dictionary with the given maximum length and name. Number of dict slots handed out so far; the store’s high-water mark.

pub fn truncate_to(&mut self, dicts_len: usize, entity_len: usize)

Release every dict slot and entity from the given marks onward.

Used by restore to reclaim the objects a save level created. See crate::entity_table::EntityTable::truncate for the safety argument and the EntityId-reuse caveat.

pub fn allocate(&mut self, max_length: usize, name: &[u8]) -> EntityId

pub fn allocate_with( &mut self, max_length: usize, name: &[u8], save_level: u16, global: bool, created_after_save: u32, ) -> EntityId

Allocate with a specific save level and global flag.

pub fn iter_entities(&self) -> impl Iterator<Item = (EntityId, &DictEntry)>

Iterate every allocated dictionary in this store as (EntityId, &DictEntry).

Used by the VM audit (see crate::vm_audit) to sweep global VM for PLRM 3.7.2 violations. Iterating entities rather than following references from a root set is deliberate: it catches dictionaries that nothing reachable points at, and it does not depend on writes having gone through DictStore::put.

pub fn get(&self, entity: EntityId, key: &DictKey) -> Option<PsObject>

Look up a key in a dictionary.

pub fn put(&mut self, entity: EntityId, key: DictKey, value: PsObject)

Insert or update a key-value pair.

pub fn known(&self, entity: EntityId, key: &DictKey) -> bool

Check if a key exists.

pub fn get_name(&self, entity: EntityId) -> &[u8]

Get the dict’s name.

pub fn set_name(&mut self, entity: EntityId, name: &[u8])

Set the dict’s name.

pub fn length(&self, entity: EntityId) -> usize

Current number of entries.

pub fn max_length(&self, entity: EntityId) -> usize

Maximum capacity.

pub fn remove(&mut self, entity: EntityId, key: &DictKey)

Remove a key.

pub fn entry(&self, entity: EntityId) -> &DictEntry

Borrow the dict entry.

pub fn entry_mut(&mut self, entity: EntityId) -> &mut DictEntry

Mutably borrow the dict entry.

pub fn keys(&self, entity: EntityId) -> impl Iterator<Item = &DictKey>

Iterate over keys of a dictionary.

pub fn access(&self, entity: EntityId) -> u8

Get the access level of a dictionary.

pub fn require_read(&self, entity: EntityId) -> Result<(), PsError>

Require read access on a dict. Returns InvalidAccess if access < READ_ONLY.

pub fn require_write(&self, entity: EntityId) -> Result<(), PsError>

Require write access on a dict. Returns InvalidAccess if access < UNLIMITED.

pub fn set_access(&mut self, entity: EntityId, access: u8)

Set the access level of a dictionary.

pub fn cow_copy(&mut self, entity: EntityId) -> EntityId

Copy a dictionary’s contents to a new dict (for COW). Returns the new EntityId. The original entity is updated to point at the copy; the returned entity points at the original data (the backup).

pub fn swap_offsets(&mut self, a: EntityId, b: EntityId)

Swap indices between two entities (used by restore).

Trait Implementations

impl Default for DictStore

fn default() -> Self

Returns the “default value” for a type.