Struct sunrise_libuser::types::SharedMemory

#[repr(transparent)]pub struct SharedMemory(pub Handle);

A handle to memory that may be mapped in multiple processes at the same time.

Special care should be used to ensure multiple processes do not write to the memory at the same time, or only does so through the use of atomic operations. Otherwise, UB will occur!

Implementations

impl SharedMemory

pub fn new(
    length: usize,
    myperm: MemoryPermissions,
    otherperm: MemoryPermissions
) -> Result<SharedMemory, Error>

Creates a new Shared Memory handle. The physical memory underlying this shared memory will span length bytes.

Myperm and otherperm are masks of which permissions are allowed when mapping the shared memory in the current process and other processes respectively.

pub fn map(
    self,
    addr: usize,
    size: usize,
    perm: MemoryPermissions
) -> Result<MappedSharedMemory, Error>

Maps the current shared memory at the given address, consuming the handle and returning a MappedMemoryRegion. Note that the size must be equal to the length of the SharedMemory.

Trait Implementations

impl Debug for SharedMemory

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.