Struct GLockGuard

pub struct GLockGuard<'lck, T: 'lck> { /* private fields */ }

A GLockGuard represents an acquired lock instance of any type. It can be used to access the protected data. The lock is released by dropping the GLockGuard object.

Implementations

impl<'lck, T: 'lck> GLockGuard<'lck, T>

pub fn lock_type(&self) -> LockResult<LockType>

Returns the type of the lock currently held.

pub fn upgrade(&self, to_type: LockType) -> LockResult<()>

Upgrades the type of this GLockGuard to the specified type. If parent lock does not support the new type, it will be upgraded as well. If the lock is currently busy, it will block until it is ready.

pub fn try_upgrade(&self, to_type: LockType) -> LockResult<()>

Attempts to upgrade the type of this GLockGuard to the specified type. If parent lock does not support the new type, it will be upgraded as well. If the lock is currently busy, it will return a LockError::LockBusy error.

pub fn upgrade_to_exclusive( self, ) -> Result<GLockGuardMut<'lck, T>, (LockError, GLockGuard<'lck, T>)>

Upgrades the type of this GLockGuard to Exclusive. If parent lock does not support the new type, it will be upgraded as well. If the lock is currently busy, it will block until it is ready.

This method consumes the current GLockGuard and returns a new GLockGuardMut. In case of failure, it will return a tuple containing the error as well as the original GLockGuard.

pub fn try_upgrade_to_exclusive( self, ) -> Result<GLockGuardMut<'lck, T>, (LockError, GLockGuard<'lck, T>)>

Attempts to upgrade the type of this GLockGuard to Exclusive. If parent lock does not support the new type, it will be upgraded as well. If the lock is currently busy, If the lock is currently busy, it will return a LockError::LockBusy error.

This method consumes the current GLockGuard and returns a new GLockGuardMut. In case of failure, it will return a tuple containing the error as well as the original GLockGuard.

Trait Implementations

impl<'lck, T: Debug + 'lck> Debug for GLockGuard<'lck, T>

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

Formats the value using the given formatter.

impl<'lck, T: 'lck> Deref for GLockGuard<'lck, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Self as Deref>::Target

Dereferences the value.