Struct shared_memory::ShmemConf

pub struct ShmemConf { /* fields omitted */ }

Struct used to configure different parameters before creating a shared memory mapping

Implementations

impl ShmemConf

pub fn new() -> Self

Create a new default shmem config

pub fn os_id<S: AsRef<str>>(self, os_id: S) -> Self

Provide a specific os identifier for the mapping

When not specified, a randomly generated identifier will be used

pub fn force_create_flink(self) -> Self

Overwrites file links if it already exist when calling create()

pub fn flink<S: AsRef<Path>>(self, path: S) -> Self

Create the shared memory mapping with a file link

This creates a file on disk that contains the unique os_id for the mapping. This can be useful when application want to rely on filesystems to share mappings

pub fn size(self, size: usize) -> Self

Sets the size of the mapping that will be used in create()

pub fn create(self) -> Result<Shmem, ShmemError>

Create a new mapping using the current configuration

pub fn open(self) -> Result<Shmem, ShmemError>

Opens an existing mapping using the current configuration

Trait Implementations

impl Clone for ShmemConf

fn clone(&self) -> ShmemConf

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ShmemConf

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ShmemConf

fn drop(&mut self)

Executes the destructor for this type.