Skip to main content

FlatSlot

Struct FlatSlot 

Source
pub struct FlatSlot<'a, T: FlatStruct> { /* private fields */ }
Expand description

Loaned slot. The caller sets the sample via write() and then calls commit(). Dropping without a commit discards the loan.

Implementations§

Source§

impl<T: FlatStruct> FlatSlot<'_, T>

Source

pub fn commit(self, sample: T) -> Result<u32, SlotError>

Writes the sample into the slot.

§Errors

As for commit_slot.

Source

pub fn as_mut(&mut self) -> Result<&mut T, SlotError>

True zero-copy (Spec §8.2): a &mut T view directly onto the SHM slot. The slot’s WIRE_SIZE bytes are zeroed first (so the all-zero bit pattern is a valid Tbool fields are false, etc.); the caller fills the fields in place, then calls Self::commit_in_place. No staging buffer and no copy on commit.

§Errors

NoFreeSlot/OutOfBounds/SampleTooLarge from the backend.

Source

pub fn commit_in_place(self) -> Result<u32, SlotError>

Commits a slot whose T was written in place via Self::as_mut — no copy (counterpart to Self::commit). Returns the SN.

§Errors

As for commit_in_place.

Trait Implementations§

Source§

impl<T: FlatStruct> Drop for FlatSlot<'_, T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for FlatSlot<'a, T>

§

impl<'a, T> RefUnwindSafe for FlatSlot<'a, T>

§

impl<'a, T> Send for FlatSlot<'a, T>

§

impl<'a, T> Sync for FlatSlot<'a, T>

§

impl<'a, T> Unpin for FlatSlot<'a, T>

§

impl<'a, T> UnsafeUnpin for FlatSlot<'a, T>

§

impl<'a, T> UnwindSafe for FlatSlot<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V