Adding `locker` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add locker

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

locker = "0.4.3"

The locker library will be automatically available globally. Read the locker library documentation.

Back to the crate overview.

Readme

Locker

Utility locker - simple async/sync locker for rust concurrency.

Async Example

use std::time::Duration;
use locker::AsyncLocker;
use tokio::time::delay_for;

let default_mutex_value = "value";
let locker = AsyncLocker::<i32, &str>::new_custom(move || default_mutex_value);
let mutex = locker.get_mutex(1).await;
let _guard = mutex.lock().await; // lock
let locker_clone = locker.clone();
tokio::spawn(async move {
    let mutex = locker.get_mutex(1).await;
    let value = mutex.lock().await; // wait
    assert_eq!(default_mutex_value, *value);
});
delay_for(Duration::from_millis(200)).await;

Sync Example

use std::time::Duration;
use std::thread;
use locker::SyncLocker;

let locker = SyncLocker::new();
let mutex = locker.get_mutex(1);
let _guard = mutex.lock().unwrap(); // lock
let locker_clone = locker.clone();
thread::spawn(move || {
    let mutex = locker.get_mutex(1);
    let _guard = mutex.lock().unwrap(); // wait
});
thread::sleep(Duration::from_millis(200));

Run test

To run tests:

cargo test -- --nocapture

Adding locker library as a dependency

Adding `locker` library as a dependency