Struct SharedMemory 

pub struct SharedMemory { /* private fields */ }

Shared memory region for inter-process communication

Implementations

impl SharedMemory

pub fn create(name: &str, size: usize) -> Result<Self>

Create a new shared memory region with the given name and size

The name should be unique across the system. On Unix, it will be prefixed with / if not already. On Windows, it will be used as-is.

pub fn open(name: &str) -> Result<Self>

Open an existing shared memory region

pub fn name(&self) -> &str

Get the name of the shared memory region

pub fn size(&self) -> usize

Get the size of the shared memory region

pub fn is_owner(&self) -> bool

Check if this instance is the owner (creator) of the shared memory

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

Get a pointer to the shared memory

Safety

The caller must ensure proper synchronization when accessing the memory.

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

Get a mutable pointer to the shared memory

Safety

The caller must ensure proper synchronization when accessing the memory.

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

Get a slice view of the shared memory

Safety

The caller must ensure no other process is writing to this region.

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

Get a mutable slice view of the shared memory

Safety

The caller must ensure exclusive access to this region.

pub fn write(&mut self, offset: usize, data: &[u8]) -> Result<()>

Write data to the shared memory at the given offset

Returns error if offset + data.len() exceeds the size.

pub fn read(&self, offset: usize, len: usize) -> Result<Vec<u8>>

Read data from the shared memory at the given offset

Returns error if offset + len exceeds the size.

pub fn read_into(&self, offset: usize, buf: &mut [u8]) -> Result<()>

Read data into an existing buffer

Trait Implementations

impl Drop for SharedMemory

fn drop(&mut self)

Executes the destructor for this type.

impl Send for SharedMemory

impl Sync for SharedMemory