Struct drone_core::sync::Mutex

pub struct Mutex<T: ?Sized> { /* fields omitted */ }

A mutual exclusion primitive useful for protecting shared data.

The mutex can be statically initialized or created via a Mutex::new constructor. Each mutex has a type parameter which represents the data that it is protecting. The data can only be accessed through the RAII guard returned from Mutex::try_lock, which guarantees that the data is only ever accessed when the mutex is locked.

Implementations

impl<T> Mutex<T>

pub const fn new(data: T) -> Self

Creates a new mutex in an unlocked state ready for use.

Examples

use drone_core::sync::Mutex;

let mutex = Mutex::new(0);

pub fn into_inner(self) -> T

Consumes this mutex, returning the underlying data.

Examples

use drone_core::sync::Mutex;

let mutex = Mutex::new(0);
assert_eq!(mutex.into_inner(), 0);

impl<T: ?Sized> Mutex<T>

pub fn try_lock(&self) -> Option<MutexGuard<'_, T>>

Attempts to acquire this lock.

If the lock could not be acquired at this time, then None is returned. Otherwise, an RAII guard is returned. The lock will be unlocked when the guard is dropped.

Examples

use drone_core::sync::Mutex;
use std::{sync::Arc, thread};

let mutex = Arc::new(Mutex::new(0));
let c_mutex = Arc::clone(&mutex);

thread::spawn(move || {
    let mut lock = c_mutex.try_lock();
    if let Some(ref mut mutex) = lock {
        **mutex = 10;
    } else {
        println!("try_lock failed");
    }
})
.join()
.expect("thread::spawn failed");
assert_eq!(*mutex.try_lock().unwrap(), 10);

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this call borrows the Mutex mutably, no actual locking needs to take place -- the mutable borrow statically guarantees no locks exist.

Examples

use drone_core::sync::Mutex;

let mut mutex = Mutex::new(0);
*mutex.get_mut() = 10;
assert_eq!(*mutex.try_lock().unwrap(), 10);

Trait Implementations

impl<T: ?Sized + Debug> Debug for Mutex<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Default> Default for Mutex<T>

pub fn default() -> Self

Creates a Mutex<T>, with the Default value for T.

impl<T> From<T> for Mutex<T>

pub fn from(data: T) -> Self

Creates a new mutex in an unlocked state ready for use. This is equivalent to Mutex::new.

impl<T: ?Sized + Send> Send for Mutex<T>

impl<T: ?Sized + Send> Sync for Mutex<T>