Struct Mutex

pub struct Mutex<T>(/* private fields */);

Provides interior mutability.

It’s tailored for internal use in egui should only be used for short locks (as a guideline, locks should never be held longer than a single frame). In debug builds, when a lock can’t be acquired within 10 seconds, we assume a deadlock and will panic.

This is a thin wrapper around parking_lot::Mutex.

Implementations

impl<T> Mutex<T>

pub fn new(val: T) -> Self

pub fn lock(&self) -> MutexGuard<'_, T>

Try to acquire the lock.

Panics

Will panic in debug builds if the lock can’t be acquired within 10 seconds.

Trait Implementations

impl<T> Clone for Mutex<T>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Default> Default for Mutex<T>

fn default() -> Mutex<T>

Returns the “default value” for a type.