embassy-sync

Crates

git

Versions

default

Flavors

embassy_sync::blocking_mutex

Struct ThreadModeMutex

Source
pub struct ThreadModeMutex<T: ?Sized> { /* private fields */ }
Expand description

A “mutex” that only allows borrowing from thread mode.

§Safety

This Mutex is only safe on single-core systems.

On multi-core systems, a ThreadModeMutex is not sufficient to ensure exclusive access.

Implementations§

Source§

impl<T> ThreadModeMutex<T>

Source

pub const fn new(value: T) -> Self

Creates a new mutex

Source§

impl<T: ?Sized> ThreadModeMutex<T>

Source

pub fn lock<R>(&self, f: impl FnOnce(&T) -> R) -> R

Lock the ThreadModeMutex, granting access to the data.

§Panics

This will panic if not currently running in thread mode.

Source

pub fn borrow(&self) -> &T

Borrows the data

§Panics

This will panic if not currently running in thread mode.

Trait Implementations§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T: ?Sized> Send for ThreadModeMutex<T>

Source§

impl<T: ?Sized> Sync for ThreadModeMutex<T>

Auto Trait Implementations§

§

impl<T> !Freeze for ThreadModeMutex<T>

§

impl<T> !RefUnwindSafe for ThreadModeMutex<T>

§

impl<T> Unpin for ThreadModeMutex<T>
where T: Unpin + ?Sized,

§

impl<T> UnwindSafe for ThreadModeMutex<T>
where T: UnwindSafe + ?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, 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 = 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.