Struct shared_memory::Shmem

source · [−]

pub struct Shmem { /* private fields */ }

Expand description

Structure used to extract information from an existing shared memory mapping

Implementations

source

impl Shmem

source

pub fn is_owner(&self) -> bool

Returns whether we created the mapping or not

source

pub fn set_owner(&mut self, is_owner: bool) -> bool

Allows for gaining/releasing ownership of the mapping

Warning : You must ensure at least one process owns the mapping in order to ensure proper cleanup code is ran

source

pub fn get_os_id(&self) -> &str

Returns the OS unique identifier for the mapping

source

pub fn get_flink_path(&self) -> Option<&PathBuf>

Returns the flink path if present

source

pub fn len(&self) -> usize

Returns the total size of the mapping

source

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

Returns a raw pointer to the mapping

source

pub unsafe fn as_slice(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns mapping as a byte slice

Safety

This function is unsafe because it is impossible to ensure the range of bytes is immutable

source

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns mapping as a mutable byte slice

Safety

This function is unsafe because it is impossible to ensure the returned mutable refence is unique/exclusive

Auto Trait Implementations

impl RefUnwindSafe for Shmem

impl !Send for Shmem

impl !Sync for Shmem

impl Unpin for Shmem

impl UnwindSafe for Shmem

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct shared_memory::Shmem

Implementations

impl Shmem

pub fn is_owner(&self) -> bool

pub fn set_owner(&mut self, is_owner: bool) -> bool

pub fn get_os_id(&self) -> &str

pub fn get_flink_path(&self) -> Option<&PathBuf>

pub fn len(&self) -> usize

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

pub unsafe fn as_slice(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Safety

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Safety

Auto Trait Implementations

impl RefUnwindSafe for Shmem

impl !Send for Shmem

impl !Sync for Shmem

impl Unpin for Shmem

impl UnwindSafe for Shmem

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

Struct shared_memory::Shmem

Implementations

impl Shmem

pub fn is_owner(&self) -> bool

pub fn set_owner(&mut self, is_owner: bool) -> bool

pub fn get_os_id(&self) -> &str

pub fn get_flink_path(&self) -> Option<&PathBuf>

pub fn len(&self) -> usize

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

pub unsafe fn as_slice(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Safety

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Safety

Auto Trait Implementations

impl RefUnwindSafe for Shmem

impl !Send for Shmem

impl !Sync for Shmem

impl Unpin for Shmem

impl UnwindSafe for Shmem

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

pub unsafe fn as_slice(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub unsafe fn as_slice_mut(&mut self) -> &mut [u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,