Struct MutexRef

pub struct MutexRef<'a> { /* private fields */ }

Available on crate feature unstable only.

A borrowed reference to a mutex.

Implementations

impl MutexRef<'_>

Object ID conversion

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a MutexRef from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn as_raw(self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(self) -> NonNullID

Get the raw object ID as abi::NonNullID.

impl MutexRef<'_>

Management

pub unsafe fn delete(self) -> Result<(), Error<DeleteError>>

Available on crate feature dcre only.

del_mtx: Delete the mutex.

Safety

See Object ID Wrappers.

pub fn info(self) -> Result<Info, Error<InfoError>>

ref_mtx: Get the mutex’s general information.

impl MutexRef<'_>

Mutex Operations

pub fn lock(self) -> Result<(), Error<LockError>>

loc_mtx: Lock the mutex.

pub fn lock_timeout(self, tmo: Timeout) -> Result<(), Error<LockTimeoutError>>

tloc_mtx: Lock the mutex with timeout.

pub fn try_lock(self) -> Result<(), Error<TryLockError>>

ploc_mtx: Attempt to lock the mutex. Returns immediately if it’s already locked.

pub fn unlock(self) -> Result<(), Error<UnlockError>>

unl_mtx: Unlock the mutex.

pub fn initialize(self) -> Result<(), Error<InitializeError>>

ini_mtx: Initialize the mutex.

Trait Implementations

impl<'a> Clone for MutexRef<'a>

fn clone(&self) -> MutexRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutexRef<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for MutexRef<'a>

fn eq(&self, other: &MutexRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Copy for MutexRef<'a>

impl<'a> Eq for MutexRef<'a>

impl<'a> StructuralPartialEq for MutexRef<'a>