Struct SortMutex 

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

A sortable lock that ensures exclusive access to a resource. This is a sortable version of rust’s Mutex type.

Locking looks a little different to Mutex, as this lock allows sorting with other locks through the use of lock_all.

use sortlock::{SortMutex, LockGroup};

let lock = SortMutex::new("some value");

let guard = lock.lock().lock_all();
println!("{}", *guard);

With multiple locks this ensures that locks are always locked in the same order:

use sortlock::{SortMutex, LockGroup};

let lock1 = SortMutex::new("some value");
let lock2 = SortMutex::new("some other value");

// Here lock1 is locked then lock2.
let (guard1, guard2) = (lock1.lock(), lock2.lock()).lock_all();
println!("{}", *guard1);
println!("{}", *guard2);

// Unlock so we can lock again.
drop(guard1);
drop(guard2);

// Despite the order change the same is true here.
let (guard2, guard1) = (lock2.lock(), lock1.lock()).lock_all();
println!("{}", *guard1);
println!("{}", *guard2);

Implementations

impl<T> SortMutex<T>

pub fn new(value: T) -> Self

Creates a new SortLock.

• value - The value of the lock.

pub fn lock(&self) -> SortMutexGuard<'_, T>

Requests to lock this lock. This method returns a guard which can be used with lock_all to perform a sorted lock.

Panicking

The guard will panic when locked if this lock becomes poisoned.

Trait Implementations

impl<T: Debug> Debug for SortMutex<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for SortMutex<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display> Display for SortMutex<T>

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

Formats the value using the given formatter.