Skip to main content

TargetSlot

Struct TargetSlot 

Source
pub struct TargetSlot<const N: usize> { /* private fields */ }
Expand description

The latest target, N f64s, as a single-writer seqlock: the sequence number is odd while a write is in progress and changes with every write, so a reader that sees the same even number before and after loading the values has a consistent set. Reads never block and never spin unboundedly, which is what lets the realtime loop poll it every cycle; writes are wait-free too, but there must be only one writer at a time, which the handles serialise with a mutex on the user side.

The Default slot holds zeros with sequence 0, which TargetSlot::load reports as “never written” through its false return: the loop then keeps the target it has.

Implementations§

Source§

impl<const N: usize> TargetSlot<N>

Source

pub fn new(initial: [f64; N]) -> Self

A slot holding initial, already published (sequence 2).

Source

pub fn publish(&self, target: [f64; N])

Publishes target. The single writer; wait-free.

Source

pub fn load(&self, into: &mut [f64; N]) -> bool

Copies the latest consistent target into into and returns true; false, with into untouched, if the writer was mid-update on every one of three tries or nothing has been published yet.

Source

pub fn sequence(&self) -> u64

The number of completed writes, times two (the sequence number).

Trait Implementations§

Source§

impl<const N: usize> Debug for TargetSlot<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: usize> Default for TargetSlot<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<const N: usize> !Freeze for TargetSlot<N>

§

impl<const N: usize> RefUnwindSafe for TargetSlot<N>

§

impl<const N: usize> Send for TargetSlot<N>

§

impl<const N: usize> Sync for TargetSlot<N>

§

impl<const N: usize> Unpin for TargetSlot<N>

§

impl<const N: usize> UnsafeUnpin for TargetSlot<N>

§

impl<const N: usize> UnwindSafe for TargetSlot<N>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.