Struct parking_lot::raw_rwlock::RawRwLock

pub struct RawRwLock {
    state: AtomicUsize,
}

Raw reader-writer lock type backed by the parking lot.

Fields

state: AtomicUsize

Implementations

impl RawRwLock

fn try_lock_shared_fast(&self, recursive: bool) -> bool

fn try_lock_shared_slow(&self, recursive: bool) -> bool

fn try_lock_upgradable_fast(&self) -> bool

fn try_lock_upgradable_slow(&self) -> bool

fn lock_exclusive_slow(&self, timeout: Option<Instant>) -> bool

fn unlock_exclusive_slow(&self, force_fair: bool)

fn lock_shared_slow(&self, recursive: bool, timeout: Option<Instant>) -> bool

fn unlock_shared_slow(&self)

fn lock_upgradable_slow(&self, timeout: Option<Instant>) -> bool

fn unlock_upgradable_slow(&self, force_fair: bool)

fn try_upgrade_slow(&self) -> bool

fn upgrade_slow(&self, timeout: Option<Instant>) -> bool

fn downgrade_slow(&self)

fn downgrade_to_upgradable_slow(&self)

unsafe fn bump_shared_slow(&self)

fn bump_exclusive_slow(&self)

fn bump_upgradable_slow(&self)

unsafe fn wake_parked_threads( &self, new_state: usize, callback: impl FnOnce(usize, UnparkResult) -> UnparkToken, )

Common code for waking up parked threads after releasing WRITER_BIT or UPGRADABLE_BIT.

Safety

callback must uphold the requirements of the callback parameter to parking_lot_core::unpark_filter. Meaning no panics or calls into any function in parking_lot.

fn wait_for_readers(&self, timeout: Option<Instant>, prev_value: usize) -> bool

fn lock_common( &self, timeout: Option<Instant>, token: ParkToken, try_lock: impl FnMut(&mut usize) -> bool, validate_flags: usize, ) -> bool

Common code for acquiring a lock

fn deadlock_acquire(&self)

fn deadlock_release(&self)

Trait Implementations

impl RawRwLock for RawRwLock

const INIT: RawRwLock = _

Initial value for an unlocked RwLock.

type GuardMarker = GuardNoSend

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

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 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 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 RawRwLock

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 RawRwLockFair for RawRwLock

unsafe fn unlock_shared_fair(&self)

Releases a shared lock using a fair unlock protocol.

unsafe fn unlock_exclusive_fair(&self)

Releases an exclusive lock using a fair unlock protocol.

unsafe fn bump_shared(&self)

Temporarily yields a shared lock to a waiting thread if there is one.

unsafe fn bump_exclusive(&self)

Temporarily yields an exclusive lock to a waiting thread if there is one.

impl RawRwLockRecursive for RawRwLock

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 RawRwLockRecursiveTimed for RawRwLock

fn try_lock_shared_recursive_for(&self, timeout: Self::Duration) -> bool

Attempts to acquire a shared lock until a timeout is reached, without deadlocking in case of a recursive lock.

fn try_lock_shared_recursive_until(&self, timeout: Self::Instant) -> bool

Attempts to acquire a shared lock until a timeout is reached, without deadlocking in case of a recursive lock.

impl RawRwLockTimed for RawRwLock

type Duration = Duration

Duration type used for try_lock_for.

type Instant = Instant

Instant type used for try_lock_until.

fn try_lock_shared_for(&self, timeout: Self::Duration) -> bool

Attempts to acquire a shared lock until a timeout is reached.

fn try_lock_shared_until(&self, timeout: Self::Instant) -> bool

Attempts to acquire a shared lock until a timeout is reached.

fn try_lock_exclusive_for(&self, timeout: Duration) -> bool

Attempts to acquire an exclusive lock until a timeout is reached.

fn try_lock_exclusive_until(&self, timeout: Instant) -> bool

Attempts to acquire an exclusive lock until a timeout is reached.

impl RawRwLockUpgrade for RawRwLock

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 RawRwLock

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.

impl RawRwLockUpgradeFair for RawRwLock

unsafe fn unlock_upgradable_fair(&self)

Releases an upgradable lock using a fair unlock protocol.

unsafe fn bump_upgradable(&self)

Temporarily yields an upgradable lock to a waiting thread if there is one.

impl RawRwLockUpgradeTimed for RawRwLock

fn try_lock_upgradable_until(&self, timeout: Instant) -> bool

Attempts to acquire an upgradable lock until a timeout is reached.

fn try_lock_upgradable_for(&self, timeout: Duration) -> bool

Attempts to acquire an upgradable lock until a timeout is reached.

unsafe fn try_upgrade_until(&self, timeout: Instant) -> bool

Attempts to upgrade an upgradable lock to an exclusive lock until a timeout is reached.

unsafe fn try_upgrade_for(&self, timeout: Duration) -> bool

Attempts to upgrade an upgradable lock to an exclusive lock until a timeout is reached.