Struct greenie::common::mutex::Mutex

pub struct Mutex { /* fields omitted */ }

A mutual exclusion primitive useful for protecting shared data

This mutex will block threads waiting for the lock to become available. The mutex can also be statically initialized or created via a new constructor. Each mutex has a type parameter which represents the data that it is protecting. The data can only be accessed through the RAII guards returned from lock and try_lock, which guarantees that the data is only ever accessed when the mutex is locked.

Methods

impl Mutex

pub fn new() -> Self

Creates a new mutex in an unlocked state ready for use.

pub fn lock(&self)

Acquires a mutex, blocking the current thread until it is able to do so.

This function will block the local thread until it is available to acquire the mutex. Upon returning, the thread is the only thread with the lock held. An RAII guard is returned to allow scoped unlock of the lock. When the guard goes out of scope, the mutex will be unlocked.

The exact behavior on locking a mutex in the thread which already holds the lock is left unspecified. However, this function will not return on the second call (it might panic or deadlock, for example).

pub fn try_lock(&self) -> bool

Attempts to acquire this lock. If the lock could not be acquired at this time, then false is returned. Otherwise, true is returned. This function does not block.

pub fn unlock(&self)

Unlock current mutex.

Panics

Panics if somebody tries to unlock mutex from another thread

Trait Implementations

impl Clone for Mutex

fn clone(&self) -> Mutex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Mutex

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Mutex

impl PartialEq<Mutex> for Mutex

fn eq(&self, other: &Mutex) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Mutex) -> bool

This method tests for !=.

impl StructuralEq for Mutex

impl StructuralPartialEq for Mutex