Struct ShmFile 

pub struct ShmFile { /* private fields */ }

Cross-platform RAM-resident named shared-memory backing.

Two handles created with the same logical name map onto the same underlying memory region. This is the cross-process visibility property that makes this distinct from MmapOptions::map_anon.

Implementations

impl ShmFile

pub fn create_or_open_named(logical_name: &str, size: usize) -> Result<Self>

Create or open a named RAM-resident shared-memory region of size bytes. Two handles created with the same logical name map onto the same underlying memory.

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

Mutable byte slice into the mapped region. Length equals the size passed at creation time. Cross-platform.

pub fn len(&self) -> usize

Length of the mapped region in bytes.

pub fn is_empty(&self) -> bool

True if the mapped region is zero bytes (never possible since create_or_open_named asserts size > 0; method exists for clippy’s len_without_is_empty).

pub fn logical_name(&self) -> &str

Logical name (without the platform prefix).

Trait Implementations

impl Drop for ShmFile

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for ShmFile

impl Sync for ShmFile