Struct shared_memory::SharedMem

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

Default shared mapping structure

Methods

impl<'a> SharedMem<'a>

pub fn create(     lock_type: LockType,     size: usize ) -> Result<SharedMem<'a>, Box<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<Error>>

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

pub fn open_linked(     existing_link_path: PathBuf ) -> Result<SharedMem<'a>, Box<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<&PathBuf>

Returns the link_path of the SharedMem

pub fn get_os_path(&self) -> &String

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> Drop for SharedMem<'a>

fn drop(&mut self)

Deletes the SharedMemConf artifacts

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

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

Formats the value using the given formatter.

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

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

Returns a read lock to the shared memory

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

Returns a read lock to the shared memory as a slice

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

fn wlock<D: SharedMemCast>(     &mut self,     lock_index: usize ) -> Result<WriteLockGuard<D>, Box<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<Error>>

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

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> 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]

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

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

Set an event to a specific state

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

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

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