Struct wasmer_types::lib::std::sync::MappedMutexGuard

source ยท
pub struct MappedMutexGuard<'a, T>
where T: 'a + ?Sized,
{ /* private fields */ }
๐Ÿ”ฌThis is a nightly-only experimental API. (mapped_lock_guards)
Available on crate feature std only.
Expand description

An RAII mutex guard returned by MutexGuard::map, which can point to a subfield of the protected data. When this structure is dropped (falls out of scope), the lock will be unlocked.

The main difference between MappedMutexGuard and MutexGuard is that the former cannot be used with Condvar, since that could introduce soundness issues if the locked object is modified by another thread while the Mutex is unlocked.

The data protected by the mutex can be accessed through this guard via its Deref and DerefMut implementations.

This structure is created by the map and try_map methods on MutexGuard.

Implementationsยง

sourceยง

impl<'a, T> MappedMutexGuard<'a, T>
where T: ?Sized,

source

pub fn map<U, F>(orig: MappedMutexGuard<'a, T>, f: F) -> MappedMutexGuard<'a, U>
where F: FnOnce(&mut T) -> &mut U, U: ?Sized,

๐Ÿ”ฌThis is a nightly-only experimental API. (mapped_lock_guards)

Makes a MappedMutexGuard for a component of the borrowed data, e.g. an enum variant.

The Mutex is already locked, so this cannot fail.

This is an associated function that needs to be used as MappedMutexGuard::map(...). A method would interfere with methods of the same name on the contents of the MutexGuard used through Deref.

source

pub fn try_map<U, F>( orig: MappedMutexGuard<'a, T>, f: F, ) -> Result<MappedMutexGuard<'a, U>, MappedMutexGuard<'a, T>>
where F: FnOnce(&mut T) -> Option<&mut U>, U: ?Sized,

๐Ÿ”ฌThis is a nightly-only experimental API. (mapped_lock_guards)

Makes a MappedMutexGuard for a component of the borrowed data. The original guard is returned as an Err(...) if the closure returns None.

The Mutex is already locked, so this cannot fail.

This is an associated function that needs to be used as MappedMutexGuard::try_map(...). A method would interfere with methods of the same name on the contents of the MutexGuard used through Deref.

Trait Implementationsยง

sourceยง

impl<T> Debug for MappedMutexGuard<'_, T>
where T: Debug + ?Sized,

sourceยง

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

Formats the value using the given formatter. Read more
sourceยง

impl<T> Deref for MappedMutexGuard<'_, T>
where T: ?Sized,

sourceยง

type Target = T

The resulting type after dereferencing.
sourceยง

fn deref(&self) -> &T

Dereferences the value.
sourceยง

impl<T> DerefMut for MappedMutexGuard<'_, T>
where T: ?Sized,

sourceยง

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

Mutably dereferences the value.
sourceยง

impl<T> Display for MappedMutexGuard<'_, T>
where T: Display + ?Sized,

sourceยง

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

Formats the value using the given formatter. Read more
sourceยง

impl<T> Drop for MappedMutexGuard<'_, T>
where T: ?Sized,

sourceยง

fn drop(&mut self)

Executes the destructor for this type. Read more
sourceยง

impl<T> !Send for MappedMutexGuard<'_, T>
where T: ?Sized,

sourceยง

impl<T> Sync for MappedMutexGuard<'_, T>
where T: Sync + ?Sized,

Auto Trait Implementationsยง

ยง

impl<'a, T> Freeze for MappedMutexGuard<'a, T>
where T: ?Sized,

ยง

impl<'a, T> RefUnwindSafe for MappedMutexGuard<'a, T>
where T: RefUnwindSafe + ?Sized,

ยง

impl<'a, T> Unpin for MappedMutexGuard<'a, T>
where T: ?Sized,

ยง

impl<'a, T> !UnwindSafe for MappedMutexGuard<'a, 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> ArchivePointee for T

sourceยง

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
sourceยง

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

sourceยง

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
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> LayoutRaw for T

sourceยง

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
sourceยง

impl<T> Pointee for T

sourceยง

type Metadata = ()

The type for metadata in pointers and references to Self.
sourceยง

impl<T> Same for T

sourceยง

type Output = T

Should always be Self
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>,

sourceยง

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>,

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.