Struct Typed 

pub struct Typed<T, Buf> { /* private fields */ }

Wrapper for SHM buffer types that is used for safe typed access to SHM data

Implementations

impl<T, Buf> Typed<T, Buf>

pub unsafe fn new_unchecked(buf: Buf) -> Self

Mark a buffer as typed.

Safety

The buffer layout must be compatible with T layout, its bytes should be initialized and respect T invariants, unless T is MaybeUninit.

pub fn inner(this: &Self) -> &Buf

Get the underlying SHM buffer

pub fn inner_mut(this: &mut Self) -> &mut Buf

Get the underlying SHM buffer

pub fn into_inner(this: Self) -> Buf

Convert into underlying SHM buffer

impl<T, Buf> Typed<MaybeUninit<T>, Buf>

pub fn new(buf: Buf) -> ZResult<Self>

where Buf: AsRef<[u8]>,

Mark a buffer as typed, checking its layout.

pub unsafe fn assume_init(self) -> Typed<T, Buf>

Assumes the underlying data is initialized.

Safety

T bytes must have been properly initialized.

pub fn initialize(self, value: T) -> Typed<T, Buf>

where Buf: ShmBufMut<[u8]>,

Initializes the underlying data.

Trait Implementations

impl<T: ResideInShm, Buf: ShmBufMut<[u8]>> AsMut<T> for Typed<T, Buf>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ResideInShm, Buf: ShmBuf<[u8]>> AsRef<T> for Typed<T, Buf>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, Buf: Clone> Clone for Typed<T, Buf>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: ResideInShm, Buf: ShmBuf<[u8]>> Deref for Typed<T, Buf>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ResideInShm, Buf: ShmBufMut<[u8]>> DerefMut for Typed<T, Buf>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> From<Typed<T, &mut zshmmut>> for Typed<T, &mut zshm>

fn from(value: Typed<T, &mut zshmmut>) -> Self

Converts to this type from the input type.

impl<T> From<Typed<T, &zshmmut>> for Typed<T, &zshm>

fn from(value: Typed<T, &zshmmut>) -> Self

Converts to this type from the input type.

impl<T> From<Typed<T, ZShmMut>> for Typed<T, ZShm>

fn from(value: Typed<T, ZShmMut>) -> Self

Converts to this type from the input type.

impl<T: ResideInShm, Buf: ShmBuf<[u8]>> ShmBuf<T> for Typed<T, Buf>

fn is_valid(&self) -> bool

impl<T: ResideInShm, Buf: ShmBufIntoImmut<[u8]>> ShmBufIntoImmut<T> for Typed<T, Buf>

type ImmutBuf = Typed<T, <Buf as ShmBufIntoImmut<[u8]>>::ImmutBuf>

fn into_immut(self) -> Self::ImmutBuf

impl<T: ResideInShm, Buf: ShmBufUnsafeMut<[u8]>> ShmBufUnsafeMut<T> for Typed<T, Buf>

unsafe fn as_mut_unchecked(&mut self) -> &mut T

Get unchecked mutable access to buffer’s memory.

impl<'a, T> TryFrom<Typed<T, &'a mut ZShm>> for Typed<T, &'a mut zshmmut>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Typed<T, &'a mut ZShm>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> TryFrom<Typed<T, &'a mut zshm>> for Typed<T, &'a mut zshmmut>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Typed<T, &'a mut zshm>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> TryFrom<Typed<T, &'a zshm>> for Typed<T, &'a zshmmut>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Typed<T, &'a zshm>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFrom<Typed<T, ZShm>> for Typed<T, ZShmMut>

type Error = Typed<T, ZShm>

The type returned in the event of a conversion error.

fn try_from(value: Typed<T, ZShm>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: ResideInShm, Buf: ShmBufMut<[u8]>> ShmBufMut<T> for Typed<T, Buf>