Struct OwnedGuard

pub struct OwnedGuard<'a> { /* private fields */ }

A guard that protects objects for it’s lifetime, independent of the current thread.

Unlike LocalGuard, an owned guard is independent of the current thread, allowing it to implement Send and Sync. This is useful for holding guards across .await points in work-stealing schedulers, where execution may be resumed on a different thread than started on. However, owned guards are more expensive to create and destroy, so should be avoided if cross-thread usage is not required.

Most of the functionality provided by this type is through the Guard trait.

Trait Implementations

impl Drop for OwnedGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Guard for OwnedGuard<'_>

fn refresh(&mut self)

Refreshes the guard.

fn flush(&self)

Flush any retired values in the local batch.

fn collector(&self) -> &Collector

Returns the collector this guard was created from.

fn thread_id(&self) -> usize

Returns a numeric identifier for the current thread.

unsafe fn defer_retire<T>( &self, ptr: *mut T, reclaim: unsafe fn(_: *mut T, _: &Collector), )

Retires a value, running reclaim when no threads hold a reference to it.

fn protect<T>(&self, ptr: &AtomicPtr<T>, order: Ordering) -> *mut T

Protects the load of an atomic pointer.

fn swap<T>(&self, ptr: &AtomicPtr<T>, value: *mut T, order: Ordering) -> *mut T

Stores a value into the pointer, returning the protected previous value.

fn compare_exchange<T>( &self, ptr: &AtomicPtr<T>, current: *mut T, new: *mut T, success: Ordering, failure: Ordering, ) -> Result<*mut T, *mut T>

Stores a value into the pointer if the current value is the same as the current value, returning the protected previous value.

fn compare_exchange_weak<T>( &self, ptr: &AtomicPtr<T>, current: *mut T, new: *mut T, success: Ordering, failure: Ordering, ) -> Result<*mut T, *mut T>

Stores a value into the pointer if the current value is the same as the current value, returning the protected previous value.

impl Send for OwnedGuard<'_>

impl Sync for OwnedGuard<'_>