Struct yaque::queue::RecvGuard

pub struct RecvGuard<'a, T> { /* private fields */ }

A guard that will only log changes on the queue state when dropped.

If it is dropped without a call to RecvGuard::commit, changes will be rolled back in a “best effort” policy: if any IO error is encountered during rollback, the state will be committed. If you can do something with the IO error, you may use RecvGuard::rollback explicitly to catch the error.

This struct implements Deref and DerefMut. If you really, really want ownership, there is RecvGuard::into_inner, but be careful, because you lose your chance to rollback if anything unexpected occurs.

Implementations

impl<'a, T> RecvGuard<'a, T>

pub fn try_into_inner(self) -> Result<T>

Commits the transaction and returns the underlying value. If you accidentally lose this value from now on, it’s your own fault!

pub fn commit(self) -> Result<()>

Commits the changes to the queue, consuming this RecvGuard.

pub fn rollback(self) -> Result<()>

Rolls the reader back to the previous point, negating the changes made on the queue. This is also done on drop. However, on drop, the possible IO error is ignored (but logged as an error) because we cannot have errors inside drops. Use this if you want to control errors at rollback.

Errors

If there is some error while moving the reader back, this error will be return.

Trait Implementations

impl<'a, T> DerefMut for RecvGuard<'a, T>

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

Mutably dereferences the value.

impl<'a, T> Drop for RecvGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> Deref for RecvGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.