pub struct SyncWrapper<T>where
    T: Send + 'static,{ /* private fields */ }
Expand description

Wrapper for objects which only provides blocking functions that need to be called on a separate thread.

Access to the wrapped object is provided via the SyncWrapper::interact() method.

Implementations§

source§

impl<T> SyncWrapper<T>where T: Send + 'static,

source

pub async fn new<F, E>(runtime: Runtime, f: F) -> Result<Self, E>where F: FnOnce() -> Result<T, E> + Send + 'static, E: Send + 'static,

Creates a new wrapped object.

source

pub async fn interact<F, R>(&self, f: F) -> Result<R, InteractError>where F: FnOnce(&mut T) -> R + Send + 'static, R: Send + 'static,

Interacts with the underlying object.

Expects a closure that takes the object as its parameter. The closure is executed in a separate thread so that the async runtime is not blocked.

source

pub fn is_mutex_poisoned(&self) -> bool

Indicates whether the underlying Mutex has been poisoned.

This happens when a panic occurs while interacting with the object.

source

pub fn lock( &self ) -> Result<SyncGuard<'_, T>, PoisonError<MutexGuard<'_, Option<T>>>>

Lock the underlying mutex and return a guard for the inner object.

source

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

Try to lock the underlying mutex and return a guard for the inner object.

Trait Implementations§

source§

impl<T> Debug for SyncWrapper<T>where T: Debug + Send + 'static,

source§

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

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

impl<T> Drop for SyncWrapper<T>where T: Send + 'static,

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for SyncWrapper<T>

§

impl<T> Send for SyncWrapper<T>

§

impl<T> Sync for SyncWrapper<T>

§

impl<T> Unpin for SyncWrapper<T>

§

impl<T> UnwindSafe for SyncWrapper<T>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.