Struct shared_memory::SharedMem

pub struct SharedMem<'a> { /* private fields */ }

Default shared mapping structure

Implementations

impl<'a> SharedMem<'a>

pub fn create(
    lock_type: LockType,
    size: usize
) -> Result<SharedMem<'a>, Box<dyn Error>>

Creates a memory mapping with no link file of specified size controlled by a single lock.

pub fn open(unique_id: &str) -> Result<SharedMem<'a>, Box<dyn Error>>

pub fn create_linked(
    new_link_path: &OsStr,
    lock_type: LockType,
    size: usize
) -> Result<SharedMem<'a>, Box<dyn Error>>

pub fn open_linked(
    existing_link_path: &OsStr
) -> Result<SharedMem<'a>, Box<dyn Error>>

pub fn get_size(&self) -> usize

Returns the size of the SharedMem

pub fn get_metadata_size(&self) -> usize

pub fn num_locks(&self) -> usize

pub fn num_events(&self) -> usize

pub fn get_link_path(&self) -> Option<&Path>

Returns the link_path of the SharedMem

pub fn get_os_path(&self) -> &str

Returns the OS specific path of the shared memory object

Usualy on Linux, this will point to a file under /dev/shm/

On Windows, this returns a namespace

pub fn get_ptr(&self) -> *mut c_void

Trait Implementations

impl<'a> Display for SharedMem<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for SharedMem<'a>

fn drop(&mut self)

Deletes the SharedMemConf artifacts

impl<'a> EventSet for SharedMem<'a>

fn set(
    &mut self,
    event_index: usize,
    state: EventState
) -> Result<(), Box<dyn Error>>

Set an event to a specific state

impl<'a> EventWait for SharedMem<'a>

fn wait(&self, event_index: usize, timeout: Timeout) -> Result<(), Box<dyn Error>>

Wait for an event to become signaled or until timeout is reached

impl<'a> ReadLockable for SharedMem<'a>

fn rlock<D: SharedMemCast>(
    &self,
    lock_index: usize
) -> Result<ReadLockGuard<'_, D>, Box<dyn Error>>

Returns a read lock to the shared memory

fn rlock_as_slice<D: SharedMemCast>(
    &self,
    lock_index: usize
) -> Result<ReadLockGuardSlice<'_, D>, Box<dyn Error>>

Returns a read lock to the shared memory as a slice

impl<'a> ReadRaw for SharedMem<'a>

unsafe fn get_raw<D: SharedMemCast>(&self) -> &D

unsafe fn get_raw_slice<D: SharedMemCast>(&self) -> &[D]

impl<'a> WriteLockable for SharedMem<'a>

fn wlock<D: SharedMemCast>(
    &mut self,
    lock_index: usize
) -> Result<WriteLockGuard<'_, D>, Box<dyn Error>>

Returns a read/write lock to the shared memory

fn wlock_as_slice<D: SharedMemCast>(
    &mut self,
    lock_index: usize
) -> Result<WriteLockGuardSlice<'_, D>, Box<dyn Error>>

Returns a read/write access to a &mut [T] on the shared memory

impl<'a> WriteRaw for SharedMem<'a>

unsafe fn get_raw_mut<D: SharedMemCast>(&mut self) -> &mut D

unsafe fn get_raw_slice_mut<D: SharedMemCast>(&mut self) -> &mut [D]