[−][src]Struct shared_memory::SharedMem
Default shared mapping structure
Methods
impl SharedMem
[src]
pub fn create(
lock_type: LockType,
size: usize
) -> Result<SharedMem, SharedMemError>
[src]
lock_type: LockType,
size: usize
) -> Result<SharedMem, SharedMemError>
Creates a memory mapping with no link file of specified size controlled by a single lock.
pub fn open(unique_id: &str) -> Result<SharedMem, SharedMemError>
[src]
pub fn create_linked<I: AsRef<OsStr>>(
new_link_path: I,
lock_type: LockType,
size: usize
) -> Result<SharedMem, SharedMemError>
[src]
new_link_path: I,
lock_type: LockType,
size: usize
) -> Result<SharedMem, SharedMemError>
pub fn open_linked<I: AsRef<OsStr>>(
existing_link_path: I
) -> Result<SharedMem, SharedMemError>
[src]
existing_link_path: I
) -> Result<SharedMem, SharedMemError>
pub fn get_size(&self) -> usize
[src]
Returns the size of the SharedMem
pub fn get_metadata_size(&self) -> usize
[src]
pub fn num_locks(&self) -> usize
[src]
pub fn num_events(&self) -> usize
[src]
pub fn get_link_path(&self) -> Option<&Path>
[src]
Returns the link_path of the SharedMem
pub fn get_os_path(&self) -> &str
[src]
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
[src]
pub fn is_owner(&self) -> bool
[src]
Trait Implementations
impl ReadLockable for SharedMem
[src]
fn rlock<D: SharedMemCast>(
&self,
lock_index: usize
) -> Result<ReadLockGuard<D>, SharedMemError>
[src]
&self,
lock_index: usize
) -> Result<ReadLockGuard<D>, SharedMemError>
fn rlock_as_slice<D: SharedMemCast>(
&self,
lock_index: usize
) -> Result<ReadLockGuardSlice<D>, SharedMemError>
[src]
&self,
lock_index: usize
) -> Result<ReadLockGuardSlice<D>, SharedMemError>
impl WriteLockable for SharedMem
[src]
fn wlock<D: SharedMemCast>(
&mut self,
lock_index: usize
) -> Result<WriteLockGuard<D>, SharedMemError>
[src]
&mut self,
lock_index: usize
) -> Result<WriteLockGuard<D>, SharedMemError>
fn wlock_as_slice<D: SharedMemCast>(
&mut self,
lock_index: usize
) -> Result<WriteLockGuardSlice<D>, SharedMemError>
[src]
&mut self,
lock_index: usize
) -> Result<WriteLockGuardSlice<D>, SharedMemError>
impl ReadRaw for SharedMem
[src]
unsafe fn get_raw<D: SharedMemCast>(&self) -> &D
[src]
unsafe fn get_raw_slice<D: SharedMemCast>(&self) -> &[D]
[src]
impl WriteRaw for SharedMem
[src]
unsafe fn get_raw_mut<D: SharedMemCast>(&mut self) -> &mut D
[src]
unsafe fn get_raw_slice_mut<D: SharedMemCast>(&mut self) -> &mut [D]
[src]
impl EventSet for SharedMem
[src]
fn set(
&mut self,
event_index: usize,
state: EventState
) -> Result<(), SharedMemError>
[src]
&mut self,
event_index: usize,
state: EventState
) -> Result<(), SharedMemError>
impl EventWait for SharedMem
[src]
impl Drop for SharedMem
[src]
impl Display for SharedMem
[src]
Auto Trait Implementations
impl !Send for SharedMem
impl Unpin for SharedMem
impl !Sync for SharedMem
impl !UnwindSafe for SharedMem
impl !RefUnwindSafe for SharedMem
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,