Trait cryo::Lock

pub unsafe trait Lock {
    type LockMarker;
    type UnlockMarker;
    fn new() -> Self;
    unsafe fn lock_shared(&self);
    unsafe fn try_lock_shared(&self) -> bool;
    unsafe fn unlock_shared(&self);
    unsafe fn lock_exclusive(&self);
    unsafe fn try_lock_exclusive(&self) -> bool;
    unsafe fn unlock_exclusive(&self);
}

A trait for readers-writer locks.

Associated Types

type LockMarker

The Send-ness of this type indicates whether a lock can only be acquired by the same thread as self’s creator.

type UnlockMarker

The Send-ness of this type indicates whether a lock can only be released by the same thread as the one that acquired it.

Loading content...

Required methods

fn new() -> Self

unsafe fn lock_shared(&self)

Acquire a shared lock, blocking the current thread until the lock is acquired.

Safety

If Self::LockMarker is !Send, the current thread must be the same one as self’s creator.

unsafe fn try_lock_shared(&self) -> bool

Acquire a shared lock.

Safety

If Self::LockMarker is !Send, the current thread must be the same one as self’s creator.

unsafe fn unlock_shared(&self)

Release a shared lock.

Safety

There must be a shared lock to release.

If Self::UnlockMarker is !Send, the current thread must own a shared lock on self.

unsafe fn lock_exclusive(&self)

Acquire an exclusive lock, blocking the current thread until the lock is acquired.

Safety

If Self::LockMarker is !Send, the current thread must be the same one as self’s creator.

unsafe fn try_lock_exclusive(&self) -> bool

Acquire an exclusive lock.

Safety

If Self::LockMarker is !Send, the current thread must be the same one as self’s creator.

unsafe fn unlock_exclusive(&self)

Release an exclusive lock.

Safety

There must be an exclusive lock to release.

If Self::UnlockMarker is !Send, the current thread must own an exclusive lock on self.

Loading content...

Implementors

impl Lock for AtomicLock

This is supported on crate feature atomic only.

type LockMarker = SendMarker

type UnlockMarker = SendMarker

fn new() -> Self

unsafe fn lock_shared(&self)

unsafe fn try_lock_shared(&self) -> bool

unsafe fn unlock_shared(&self)

unsafe fn lock_exclusive(&self)

unsafe fn try_lock_exclusive(&self) -> bool

unsafe fn unlock_exclusive(&self)

impl Lock for LocalLock

fn new() -> Self

type LockMarker = NoSendMarker

type UnlockMarker = NoSendMarker

unsafe fn lock_shared(&self)

unsafe fn try_lock_shared(&self) -> bool

unsafe fn unlock_shared(&self)

unsafe fn lock_exclusive(&self)

unsafe fn try_lock_exclusive(&self) -> bool

unsafe fn unlock_exclusive(&self)

impl Lock for SyncLock

This is supported on crate feature std only.

type LockMarker = NoSendMarker

type UnlockMarker = SendMarker

fn new() -> Self

unsafe fn lock_shared(&self)

unsafe fn try_lock_shared(&self) -> bool

unsafe fn unlock_shared(&self)

unsafe fn lock_exclusive(&self)

unsafe fn try_lock_exclusive(&self) -> bool

unsafe fn unlock_exclusive(&self)

impl<T: RawRwLock> Lock for T

This is supported on crate feature lock_api only.

This crate’s LockTrait is automatically implemented for types implementing lock_api::RawRwLock

type LockMarker = PhantomData<Self>

type UnlockMarker = T::GuardMarker

fn new() -> Self

unsafe fn lock_shared(&self)

unsafe fn try_lock_shared(&self) -> bool

unsafe fn unlock_shared(&self)

unsafe fn lock_exclusive(&self)

unsafe fn try_lock_exclusive(&self) -> bool

unsafe fn unlock_exclusive(&self)

Loading content...