Struct LocalGuard

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

A guard that keeps the current thread marked as active.

Local guards are created by calling Collector::enter. Unlike OwnedGuard, a local guard is tied to the current thread and does not implement Send. This makes local guards relatively cheap to create and destroy.

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

Trait Implementations

impl Debug for LocalGuard<'_>

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

Formats the value using the given formatter.

impl Drop for LocalGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Guard for LocalGuard<'_>

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

where T: AsLink,

Protects the load of an atomic pointer.

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

where T: AsLink,

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

fn refresh(&mut self)

Refreshes the guard.

fn flush(&self)

Flush any retired values in the local batch.

fn thread_id(&self) -> usize

Returns a numeric identifier for the current thread.

fn belongs_to(&self, collector: &Collector) -> bool

Returns true if this guard belongs to the given collector.

fn link(&self, collector: &Collector) -> Link

Create a Link that can be used to link an object to the collector.