Struct SharedMutRef 

pub struct SharedMutRef<'r, T: ?Sized + 'r>(/* private fields */);

A type which allows to share a mutable refernce and mutate the value behind it.

Implementations

impl<'r, T: ?Sized + 'r> SharedMutRef<'r, T>

pub fn new(value_ref: &'r mut T) -> Self

Creates a new SharedMutRef containing the given mutable reference.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);

pub fn into_inner(self) -> &'r mut T

Unwraps the underlying mutable reference and consumes the SharedMutRef.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
let value_ref = shared_mut_ref.into_inner();

pub fn get_temp(&self) -> Option<TempMutRef<'_, 'r, T>>

Returns a TempMutRef to the borrowed value if it wasn’t already taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
let mut temp_mut_ref = shared_mut_ref.get_temp().unwrap();
temp_mut_ref[0] = 4;
 
assert_eq!(*temp_mut_ref, vec![4, 2, 3]);

pub fn modify<U, F>(&self, f: F) -> Option<U>

where F: FnOnce(&mut T) -> U,

Modifies the borrowed value if TempMutRef wasn’t taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
shared_mut_ref.modify(|value_ref| value_ref.reverse());
assert_eq!(shared_mut_ref.get(), Some(vec![3, 2, 1]));

impl<'r, T: 'r> SharedMutRef<'r, T>

pub fn set(&self, value: T) -> Result<(), T>

Sets the borrowed value if TempMutRef wasn’t taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
shared_mut_ref.set(vec![4, 5, 6]);
assert_eq!(shared_mut_ref.get(), Some(vec![4, 5, 6]));

pub fn replace(&self, new_value: T) -> Result<T, T>

Replaces the borrowed value with new_value and returns the old borrowed value if TempMutRef wasn’t taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
assert_eq!(shared_mut_ref.replace(vec![4, 5, 6]), Ok(vec![1, 2, 3]));
assert_eq!(shared_mut_ref.get(), Some(vec![4, 5, 6]));

impl<'r, T: Default + 'r> SharedMutRef<'r, T>

pub fn take(&self) -> Option<T>

Takes the borrowed value and leaves a default value in its place if TempMutRef wasn’t taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
assert_eq!(shared_mut_ref.take(), Some(vec![1, 2, 3]));
assert_eq!(shared_mut_ref.get(), Some(vec![]));

impl<'r, T: Clone + 'r> SharedMutRef<'r, T>

pub fn get(&self) -> Option<T>

Clones the borrowed value and returns it if TempMutRef wasn’t taken.

Example

use shared_mut_ref::SharedMutRef;
 
let mut value = vec![1, 2, 3];
let shared_mut_ref = SharedMutRef::new(&mut value);
 
assert_eq!(shared_mut_ref.get(), Some(vec![1, 2, 3]));

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'r, T: ?Sized + 'r> From<&'r mut T> for SharedMutRef<'r, T>

fn from(value: &'r mut T) -> Self

Converts to this type from the input type.