Struct ArcGuard 

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

Implementations

impl<T> ArcGuard<T>

pub fn new(t: T) -> Self

Constructs a new ArcGuard<T>.

Example

use arc_guard::ArcGuard;

let indicator = ArcGuard::new(Indicator::new());

pub fn execute<R>(&self, callback: impl FnMut(Arc<Mutex<T>>) -> R) -> R

Executes a closure passed as an argument.

This is exactly what helps us avoid the boilerplate code, execute passes an Arc<Mutex<T>> clone and when the Closure finishes, the clone is automatically dropped.

Example

use arc_guard::ArcGuard;

let indicator = ArcGuard::new(Indicator::new());

indicator.execute(|indicator| {
    let indicator = indicator.lock().expect("Unable to lock indicator.");
    indicator.do_something();
});

execute takes the return type of the Closure as its own, so you are able to return from your closure into a variable.

Example

use arc_guard::ArcGuard;

let indicator = ArcGuard::new(Indicator::new());

let some_string: String = indicator.execute(|indicator| -> String {
    let indicator = indicator.lock().expect("Unable to lock indicator.");
    return indicator.something();
});

pub fn arc(&self) -> Arc<Mutex<T>>

In some cases it is convenient to use Arc<Mutex<T>>, instead of ArcGuard<T>.

With this method you are able to get a clone of the inner Arc<Mutex<T>>.

Example

use arc_guard::ArcGuard;

let indicator = ArcGuard::new(Indicator::new());

let inner_arc = indicator.arc();

pub fn clone(&self) -> Self

Returns new ArcGuard with a clone of the inner Arc<Mutex<T>>.

Example

use arc_guard::ArcGuard;

let indicator = ArcGuard::new(Indicator::new());

let indicator_clone = indicator.clone();