Struct shared_memory::Shmem

pub struct Shmem { /* fields omitted */ }

Structure used to extract information from an existing shared memory mapping

Implementations

impl Shmem

pub fn is_owner(&self) -> bool

Returns whether we created the mapping or not

pub fn set_owner(&mut self, is_owner: bool) -> bool

Allows for gaining/releasing ownership of the mapping

Warning : You must ensure at least one process owns the mapping in order to ensure proper cleanup code is ran

pub fn get_os_id(&self) -> &str

Returns the OS unique identifier for the mapping

pub fn get_flink_path(&self) -> Option<&PathBuf>

Returns the flink path if present

pub fn len(&self) -> usize

Returns the total size of the mapping

pub fn as_ptr(&self) -> *mut u8

Returns a raw pointer to the mapping

pub unsafe fn as_slice(&self) -> &[u8]

Returns mapping as a byte slice

Safety

This function is unsafe because it is impossible to ensure the range of bytes is immutable

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8]

Returns mapping as a mutable byte slice

Safety

This function is unsafe because it is impossible to ensure the returned mutable refence is unique/exclusive