Struct Ref

pub struct Ref<'slot, T> { /* private fields */ }

A reference to an entry in a ThingBuf.

A Ref represents the exclusive permission to mutate a given element in a queue. A Ref<T> implements DerefMut<T> to allow writing to that element.

Refs are returned by the ThingBuf::push_ref and ThingBuf::pop_ref methods. When the Ref is dropped, the exclusive write access to that element is released, and the push or pop operation is completed — calling push_ref or pop_ref begins a push or pop operation, which ends when the returned Ref is complete. When the Ref is dropped, the pushed element will become available to a subsequent pop_ref, or the popped element will be able to be written to by a push_ref, respectively.

Trait Implementations

impl<T: Debug> Debug for Ref<'_, T>

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

Formats the value using the given formatter.

impl<T> Deref for Ref<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Ref<'_, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Display> Display for Ref<'_, T>

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

Formats the value using the given formatter.

impl<T> Drop for Ref<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Write> Write for Ref<'_, T>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, f: Arguments<'_>) -> Result

Glue for usage of the write! macro with implementors of this trait.

impl<T: Send> Send for Ref<'_, T>

impl<T: Send> Sync for Ref<'_, T>