[][src]Struct typed_shmem::ShMemCfg

pub struct ShMemCfg<T> where
    T: AsBytes + FromBytes + Default
{ /* fields omitted */ }

Configures and initilizes a shared memory region. By default, the segment name is ramdomly created and this instance is not the owner of the memory object.

Example

let memory = ShMemCfg::<u32>::default().build().unwrap();

Implementations

impl<T> ShMemCfg<T> where
    T: AsBytes + FromBytes + Default
[src]

pub fn on_file(mut self: Self, name: &str) -> Self[src]

Name of the segment of the shared memory.

Params

name: Name of the segment.

Returns

Mutable reference to the configurator.

pub fn set_owner(mut self: Self) -> Self[src]

Makes this instance the owner of the shared memory object. Only one instance referencing the same segmente can be the owner or the segment could be double freed.

Returns

Mutable reference to the configurator.

pub fn build(self) -> Result<ShMem<T>>[src]

Builds a ShMem with the configuration of this instance of ShMemCfg.

Returns

A result wrapping the memory segment.

Trait Implementations

impl<T> Default for ShMemCfg<T> where
    T: AsBytes + FromBytes + Default
[src]

Auto Trait Implementations

impl<T> RefUnwindSafe for ShMemCfg<T> where
    T: RefUnwindSafe
[src]

impl<T> Send for ShMemCfg<T> where
    T: Send
[src]

impl<T> Sync for ShMemCfg<T> where
    T: Sync
[src]

impl<T> Unpin for ShMemCfg<T> where
    T: Unpin
[src]

impl<T> UnwindSafe for ShMemCfg<T> where
    T: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.