Struct 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

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

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 T::clone() shoulnd’t give a different value, as that would make this library pretty useless

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

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. If this is called after swapping the write_lock this will return an older value. To get the newest value lock the writer and call Writeguard::read.

Needs T: Sync because maybe this is the value the reader is curently reading

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. Not upholding this doens’t lead to UB, but turns the library basically useless

impl<T, O> Drop for Writer<T, O>

fn drop(&mut self)

Executes the destructor for this type.

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

SAFETY: owns T and O

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

SAFETY: &self fn can only create a &T and never gives shared access to O