Struct MutateGuard

pub struct MutateGuard<T> { /* private fields */ }

A handle to a writeable version of the data.

This structure is created by the mutate method on CloneReplace. The data held by the guard can be accessed via its Deref and DerefMut implementations.

When the guard is dropped, the contents will be written back to become the new reference version of the data. Any intermediate writes that occurred between the mutate guard being constructed and the writeback will be discarded.

Implementations

impl<T> MutateGuard<T>

pub fn discard(self)

Discard the changes made in this mutation session.

The changed data will not be written back to its origin. If you do not call discard, the changes will always be committed when the guard goes out of scope.

Example:

use clone_replace::CloneReplace;

let c = CloneReplace::new(1);
let mut v = c.mutate();
*v = 2;
v.discard();
assert_eq!(*c.access(), 1);

Trait Implementations

impl<T> Deref for MutateGuard<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for MutateGuard<T>

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

Mutably dereferences the value.

impl<T: Display> Display for MutateGuard<T>

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

Formats the value using the given formatter.

impl<T> Drop for MutateGuard<T>

fn drop(&mut self)

Executes the destructor for this type.