Skip to main content

Mutex

Struct Mutex 

Source
pub struct Mutex<T: ?Sized>(/* private fields */);
Expand description

Async mutex matching tokio::sync::Mutex’s API shape, backed by futures::lock::Mutex.

Implementations§

Source§

impl<T> Mutex<T>

Source

pub fn new(value: T) -> Self

Construct a new mutex around value.

Source

pub fn into_inner(self) -> T

Unwrap the mutex, returning the inner value.

Source§

impl<T: ?Sized> Mutex<T>

Source

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

Acquire the mutex asynchronously.

Source

pub fn try_lock(&self) -> Result<MutexGuard<'_, T>, TryLockError>

Try to acquire without waiting. Matches tokio’s Result shape so callers can ? the error or match on success without adapting the futures-crate Option form.

Source

pub fn get_mut(&mut self) -> &mut T

Mutable access without locking — &mut self proves exclusivity statically.

Trait Implementations§

Source§

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

Source§

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

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

impl<T: Default + ?Sized> Default for Mutex<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> !Freeze for Mutex<T>

§

impl<T> !RefUnwindSafe for Mutex<T>

§

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

§

impl<T> Sync for Mutex<T>
where Mutex<T>: Sync, T: ?Sized,

§

impl<T> Unpin for Mutex<T>
where Mutex<T>: Unpin, T: ?Sized,

§

impl<T> UnsafeUnpin for Mutex<T>
where Mutex<T>: UnsafeUnpin, T: ?Sized,

§

impl<T> UnwindSafe for Mutex<T>
where Mutex<T>: UnwindSafe, T: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more