Struct Lock

pub struct Lock(/* private fields */);

Available on crate feature alloc only.

A synchronization primitive that can be used to coordinate threads.

Lock is a type that represents a lock, which can be used to ensure that only one thread can access a shared resource at a time.

Example

use utils_atomics::{Lock, lock};

let (lock, lock_sub) = lock();
std::thread::spawn(move || {
    // Do some work with the shared resource
    lock.wake();
});

// Do some work with the shared resource
lock_sub.wait();

Implementations

impl Lock

pub fn into_raw(self) -> *mut ()

Transforms the Lock into a raw mutable pointer.

pub unsafe fn from_raw(raw: *mut ()) -> Self

Constructs a Lock from a raw mutable pointer.

Safety

This function is unsafe because it assumes the provided pointer is valid and points to a Lock.

pub fn silent_drop(self)

Drops the Lock without waking up the waiting threads. This method currently leaks memory when the std feature is disabled.

impl Lock

pub fn wake(self)

Wakes up the waiting threads associated with the Lock.

Example

use utils_atomics::{Lock, lock};

let (lock, lock_sub) = lock();
std::thread::spawn(move || {
    // Do some work with the shared resource
    lock.wake();
});

// Do some work with the shared resource
lock_sub.wait();

Trait Implementations

impl Debug for Lock

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Lock

fn drop(&mut self)

Executes the destructor for this type.