Struct SyncWrapper

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

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

impl<T> SyncWrapper<T>

where T: Send + 'static,

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.

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.

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.

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

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

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

impl<T> Debug for SyncWrapper<T>

where T: Debug + Send + 'static,

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

Formats the value using the given formatter.

impl<T> Drop for SyncWrapper<T>

where T: Send + 'static,

fn drop(&mut self)

Executes the destructor for this type.