Struct shared_memory::SharedMemConf

pub struct SharedMemConf { /* fields omitted */ }

Configuration used to describe a shared memory mapping before openning/creation

Methods

impl SharedMemConf

pub fn new() -> SharedMemConf

Returns a new SharedMemConf

pub fn set_size(self, wanted_size: usize) -> SharedMemConf

Sets the size of the usable memory in the mapping

pub fn set_link_path<I: AsRef<OsStr>>(self, link_path: I) -> SharedMemConf

Sets the path for the link file

pub fn set_os_path(self, unique_id: &str) -> SharedMemConf

Sets a specific unique_id to be used when creating the mapping

pub fn add_lock(
    self,
    lock_type: LockType,
    offset: usize,
    length: usize
) -> Result<SharedMemConf, Box<dyn Error>>

Adds a lock of specified type on a range of bytes

pub fn add_event(
    self,
    event_type: EventType
) -> Result<SharedMemConf, Box<dyn Error>>

Adds an event of specified type

pub fn create(self) -> Result<SharedMem, Box<dyn Error>>

Creates a shared memory mapping from the current config values

pub fn open(self) -> Result<SharedMem, Box<dyn Error>>

Opens a shared memory mapping.

This will look at the current link_path/os_path to create the SharedMem. Other values will be reset.

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

Returns the currently set link_path value

pub fn get_os_path(&self) -> Option<&str>

Returns the currently set os_path value

pub fn get_size(&self) -> usize

Return the current size of the user data

pub fn get_metadata_size(&self) -> usize

Returns the current size that the metadata will take

pub fn num_locks(&self) -> usize

Returns the current number of locks

pub fn num_events(&self) -> usize

Returns the current number of events