Struct base::shm::SharedMemory

pub struct SharedMemory {
    pub descriptor: SafeDescriptor,
    pub size: u64,
}

A shared memory file descriptor and its size.

Fields

descriptor: SafeDescriptor

size: u64

Implementations

impl SharedMemory

pub fn new<T: Into<Vec<u8>>>(debug_name: T, size: u64) -> Result<SharedMemory>

Creates a new shared memory object of the given size.

|name| is purely for debugging purposes. It does not need to be unique, and it does not affect any non-debugging related properties of the constructed shared memory.

pub fn size(&self) -> u64

Gets the size in bytes of the shared memory.

The size returned here does not reflect changes by other interfaces or users of the shared memory file descriptor.

pub fn from_safe_descriptor( descriptor: SafeDescriptor, size: u64 ) -> Result<SharedMemory>

Creates a SharedMemory instance from a SafeDescriptor owning a reference to a shared memory descriptor. Ownership of the underlying descriptor is transferred to the new SharedMemory object.

pub fn try_clone(&self) -> Result<SharedMemory>

Clones the SharedMemory. The new SharedMemory will refer to the same underlying object as the original.

Trait Implementations

impl AsRawDescriptor for SharedMemory

USE THIS CAUTIOUSLY. On Windows, the returned handle is not a file handle and cannot be used as if it were one. It is a handle to a the associated file mapping object and should only be used for memory-mapping the file view.

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl Debug for SharedMemory

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedMemory

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SharedMemory> for SafeDescriptor

fn from(sm: SharedMemory) -> SafeDescriptor

Converts to this type from the input type.

impl PlatformSharedMemory for SharedMemory

fn new(debug_name: &CStr, size: u64) -> Result<SharedMemory>

Creates a new shared memory file descriptor with the specified size in bytes.

name will appear in /proc/self/fd/<shm fd> for the purposes of debugging. The name does not need to be unique.

The file descriptor is opened with the close on exec flag and allows memfd sealing.

If the MFD_NOEXEC_SEAL flag is supported, the resulting file will also be created with a non-executable file mode (in other words, it cannot be passed to the exec family of system calls).

fn from_safe_descriptor( descriptor: SafeDescriptor, size: u64 ) -> Result<SharedMemory>

Creates a SharedMemory instance from a SafeDescriptor owning a reference to a shared memory descriptor. Ownership of the underlying descriptor is transferred to the new SharedMemory object.

impl Serialize for SharedMemory

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SharedMemory for SharedMemory

type Error = Error

fn anon(size: u64) -> Result<Self>

Creates a new shared memory file descriptor without specifying a name.

fn size(&self) -> u64

Gets the size in bytes of the shared memory.

fn as_raw_fd(&self) -> RawDescriptor

Returns the underlying raw fd.

impl SharedMemoryLinux for SharedMemory

fn from_file(file: File) -> Result<SharedMemory>

Constructs a SharedMemory instance from a File that represents shared memory.

fn get_seals(&self) -> Result<MemfdSeals>

Gets the memfd seals that have already been added to this.

fn add_seals(&mut self, seals: MemfdSeals) -> Result<()>

Adds the given set of memfd seals.