Struct tokio::sync::OwnedMutexGuard

source ·
pub struct OwnedMutexGuard<T: ?Sized> { /* private fields */ }
Expand description

An owned handle to a held Mutex.

This guard is only available from a Mutex that is wrapped in an Arc. It is identical to MutexGuard, except that rather than borrowing the Mutex, it clones the Arc, incrementing the reference count. This means that unlike MutexGuard, it will have the 'static lifetime.

As long as you have this guard, you have exclusive access to the underlying T. The guard internally keeps a reference-counted pointer to the original Mutex, so even if the lock goes away, the guard remains valid.

The lock is automatically released whenever the guard is dropped, at which point lock will succeed yet again.

Implementations§

source§

impl<T: ?Sized> OwnedMutexGuard<T>

source

pub fn mutex(this: &Self) -> &Arc<Mutex<T>>

Returns a reference to the original Arc<Mutex>.

use std::sync::Arc;
use tokio::sync::{Mutex, OwnedMutexGuard};

async fn unlock_and_relock(guard: OwnedMutexGuard<u32>) -> OwnedMutexGuard<u32> {
    println!("1. contains: {:?}", *guard);
    let mutex: Arc<Mutex<u32>> = OwnedMutexGuard::mutex(&guard).clone();
    drop(guard);
    let guard = mutex.lock_owned().await;
    println!("2. contains: {:?}", *guard);
    guard
}

Trait Implementations§

source§

impl<T: ?Sized + Debug> Debug for OwnedMutexGuard<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ?Sized> Deref for OwnedMutexGuard<T>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<T: ?Sized> DerefMut for OwnedMutexGuard<T>

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<T: ?Sized + Display> Display for OwnedMutexGuard<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: ?Sized> Drop for OwnedMutexGuard<T>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<T> Sync for OwnedMutexGuard<T>
where T: ?Sized + Send + Sync,

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for OwnedMutexGuard<T>

§

impl<T: ?Sized> Send for OwnedMutexGuard<T>
where T: Send,

§

impl<T: ?Sized> Unpin for OwnedMutexGuard<T>

§

impl<T> !UnwindSafe for OwnedMutexGuard<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.