Struct ShmMap 

pub struct ShmMap { /* private fields */ }

A typed map of shared-memory variable names to their resolved pointers.

_context keeps the underlying Shmem mapping alive for as long as any ShmMap clone exists. The raw pointers in pointers are only valid while that mapping is mapped into this process’s address space, so the map itself must own a reference to it.

Implementations

impl ShmMap

pub fn new(pointers: HashMap<String, ShmPtr>) -> Self

Build an ShmMap with no anchored context. Only safe when the caller guarantees that the pointers’ backing memory outlives every ShmMap clone (e.g. pointers into a static buffer, or in unit tests). Prefer with_context for anything sourced from ShmContext::resolve.

pub fn with_context( pointers: HashMap<String, ShmPtr>, context: Arc<ShmContext>, ) -> Self

Build an ShmMap that anchors its lifetime to context. The Arc keeps the Shmem mapping alive even if the original owner (e.g. IpcClient::shm_context) replaces or drops its reference.

pub fn get<T>(&self, name: &str) -> Option<*mut T>

Get a typed pointer to a variable.

pub fn get_raw(&self, name: &str) -> Option<usize>

Get the raw address of a variable.

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

The data type the server declared for name, when this map was built from an ShmContext. None for a context-less map, or an unknown name.

get/read/write are untyped: nothing checks that T matches the variable, and a too-wide write silently corrupts whatever the server allocated next. Check this first when the type comes from config rather than a compile-time constant.

pub unsafe fn read<T: Copy>(&self, name: &str) -> Option<T>

Read a value from shared memory.

Safety

Caller must ensure T matches the type of data at the pointer.

pub unsafe fn write<T: Copy>(&self, name: &str, value: T) -> bool

Write a value to shared memory.

Safety

Caller must ensure T matches the type of data at the pointer.

pub fn contains(&self, name: &str) -> bool

Check if a variable name exists in the map.

pub fn len(&self) -> usize

Return the number of resolved pointers.

pub fn is_empty(&self) -> bool

Return true if no pointers were resolved.

pub fn iter(&self) -> impl Iterator<Item = (&String, &ShmPtr)>

Iterate over all (name, pointer) entries.

Trait Implementations

impl Clone for ShmMap

fn clone(&self) -> ShmMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShmMap

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

Formats the value using the given formatter.