Struct simple_left_right::Writer

pub struct Writer<T, O> { /* private fields */ }

Not realtime safe Object which can change the internal T value

Implementations

impl<T, O> Writer<T, O>

pub fn build_reader(&mut self) -> Option<Reader<T>>

get a Reader if none exists

pub fn read(&self) -> &T

The Value returned may be newer than the version the reader is currently seeing. This value will be written to next.

impl<T: Absorb<O>, O> Writer<T, O>

pub fn lock(&mut self) -> WriteGuard<'_, T, O>

Blocks if the Reader has a ReadGuard pointing to the old value.

Uses a Spinlock because for anything else the OS needs to be involved. Reader can’t talk to the OS.

pub fn try_lock(&mut self) -> Option<WriteGuard<'_, T, O>>

doesn’t block. Returns None if the Reader has a ReadGuard pointing to the old value

impl<T: Clone, O> Writer<T, O>

pub fn new(value: T) -> Self

Creates a new Writer by cloning the value once to get two values

Trait Implementations

impl<T: Debug, O: Debug> Debug for Writer<T, O>

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

Formats the value using the given formatter.

impl<T: Default, O> Default for Writer<T, O>

fn default() -> Self

Creates a new Writer by calling T::default() twice to create the two values

Default impl of T needs to give the same result every time. Doesn’t lead to UB, but turns the library basically useless