Struct Lock

pub struct Lock { /* private fields */ }

Available on crate feature threading only.

A basic locking object.

A Lock behaves like a Mutex, but carries no data. This is supposed to be used to implement other locking primitives.

Implementations

impl Lock

pub const fn new() -> Lock

Creates new unlocked Lock.

pub const fn new_locked() -> Lock

Creates new locked Lock.

pub fn is_locked(&self) -> bool

Returns the current lock state.

true if locked, false otherwise

pub fn acquire(&self)

Get this lock (blocking).

If the lock was unlocked, it will be locked and the function returns. If the lock was locked, this function will block the current thread until the lock gets unlocked elsewhere.

Panics

Panics if this is called outside of a thread context.

pub fn try_acquire(&self) -> bool

Get the lock (non-blocking).

If the lock was unlocked, it will be locked and the function returns true. If the lock was locked, the function returns false

pub fn release(&self)

Releases the lock.

If the lock was locked, and there were waiters, the first waiter will be woken up. If the lock was locked and there were no waiters, the lock will be unlocked. If the lock was not locked, the function just returns.

Trait Implementations

impl Default for Lock

fn default() -> Lock

Returns the “default value” for a type.

impl Sync for Lock