commit	b716cb303af3e430f1c6c45c843a619bafbdbfaf	[log] [tgz]
author	Android Build Coastguard Worker <[email protected]>	Sat Sep 21 01:16:18 2024 +0000
committer	Android Build Coastguard Worker <[email protected]>	Sat Sep 21 01:16:18 2024 +0000
tree	bd7116c534d29fd5c9137e2ee96c318b196f9131
parent	3d969f5525afc26ab0fa569902a3e6fab4750139 [diff]
parent	514f22cf05da96bdf709678e74bcabdf174ff65a [diff]

tree: bd7116c534d29fd5c9137e2ee96c318b196f9131

README.md

TryLock

A light-weight lock guarded by an atomic boolean.

Most efficient when contention is low, acquiring the lock is a single atomic swap, and releasing it just 1 more atomic swap.

Example

use std::sync::Arc;
use try_lock::TryLock;

// a thing we want to share
struct Widget {
    name: String,
}

// lock it up!
let widget1 = Arc::new(TryLock::new(Widget {
    name: "Spanner".into(),
}));

let widget2 = widget1.clone();


// mutate the widget
let mut locked = widget1.try_lock().expect("example isn't locked yet");
locked.name.push_str(" Bundle");

// hands off, buddy
let not_locked = widget2.try_lock();
assert!(not_locked.is_none(), "widget1 has the lock");

// ok, you can have it
drop(locked);

let locked2 = widget2.try_lock().expect("widget1 lock is released");

assert_eq!(locked2.name, "Spanner Bundle");