Struct RawOneShotRwLock

pub struct RawOneShotRwLock { /* private fields */ }

A one-shot readers-writer lock that panics instead of (dead)locking on contention.

This lock allows no contention and panics on lock_shared, lock_exclusive, lock_upgradable, and upgrade if it is already locked conflictingly. This is useful in situations where contention would be a bug, such as in single-threaded programs that would deadlock on contention.

Examples

use one_shot_mutex::sync::OneShotRwLock;

static X: OneShotRwLock<i32> = OneShotRwLock::new(42);

// This is equivalent to `X.try_write().unwrap()`.
let x = X.write();

// This panics instead of deadlocking.
// let x2 = X.write();

// Once we unlock the mutex, we can lock it again.
drop(x);
let x = X.write();

Implementations

impl RawOneShotRwLock

pub const fn new() -> Self

Trait Implementations

impl Default for RawOneShotRwLock

fn default() -> Self

Returns the “default value” for a type.

impl RawRwLock for RawOneShotRwLock

const INIT: Self

Initial value for an unlocked RwLock.

type GuardMarker = GuardSend

Marker type which determines whether a lock guard should be Send. Use one of the GuardSend or GuardNoSend helper types here.

fn lock_shared(&self)

Acquires a shared lock, blocking the current thread until it is able to do so.

fn try_lock_shared(&self) -> bool

Attempts to acquire a shared lock without blocking.

unsafe fn unlock_shared(&self)

Releases a shared lock.

fn lock_exclusive(&self)

Acquires an exclusive lock, blocking the current thread until it is able to do so.

fn try_lock_exclusive(&self) -> bool

Attempts to acquire an exclusive lock without blocking.

unsafe fn unlock_exclusive(&self)

Releases an exclusive lock.

fn is_locked(&self) -> bool

Checks if this RwLock is currently locked in any way.

fn is_locked_exclusive(&self) -> bool

Check if this RwLock is currently exclusively locked.

impl RawRwLockDowngrade for RawOneShotRwLock

unsafe fn downgrade(&self)

Atomically downgrades an exclusive lock into a shared lock without allowing any thread to take an exclusive lock in the meantime.

impl RawRwLockRecursive for RawOneShotRwLock

fn lock_shared_recursive(&self)

Acquires a shared lock without deadlocking in case of a recursive lock.

fn try_lock_shared_recursive(&self) -> bool

Attempts to acquire a shared lock without deadlocking in case of a recursive lock.

impl RawRwLockUpgrade for RawOneShotRwLock

fn lock_upgradable(&self)

Acquires an upgradable lock, blocking the current thread until it is able to do so.

fn try_lock_upgradable(&self) -> bool

Attempts to acquire an upgradable lock without blocking.

unsafe fn unlock_upgradable(&self)

Releases an upgradable lock.

unsafe fn upgrade(&self)

Upgrades an upgradable lock to an exclusive lock.

unsafe fn try_upgrade(&self) -> bool

Attempts to upgrade an upgradable lock to an exclusive lock without blocking.

impl RawRwLockUpgradeDowngrade for RawOneShotRwLock

unsafe fn downgrade_upgradable(&self)

Downgrades an upgradable lock to a shared lock.

unsafe fn downgrade_to_upgradable(&self)

Downgrades an exclusive lock to an upgradable lock.