Struct flize::FullShield

pub struct FullShield<'a> { /* fields omitted */ }

A FullShield is largely equivalent to ThinShield in terms of functionality. They're both shields with the same guarantees and can be user interchangeably. The major difference is that FullShield implements Send and Sync while Shield does not. FullShield is provided for scenarios like asynchronous iteration over a datastructure which is a big pain if the iterator isn't Send.

The downside to this functionality is that they are much more expensive to create and destroy and even more so when multiple threads are creating and destroying them at the same time. This is due to the fact that full shields require more bookkeeping to handle the fact that they may suddently change locals/threads.

While the latency of creation and destruction of a FullShield is for the most part relatively constant it does involve accessing state protected by a Mutex. This means that in the unfortunate event that a thread gets preempted in this critical section creation and destruction may block. This is in constrast to the wait-free creation and destruction of a ThinShield.

For documentation on functionality please check the documentation of the Shield trait.

Trait Implementations

impl<'a> Clone for FullShield<'a>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Drop for FullShield<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Send for FullShield<'a>

impl<'a> Shield<'a> for FullShield<'a>

fn repin(&mut self)

Attempt to synchronize the current thread to allow advancing the global epoch. This might be useful to call every once in a while if you plan on holding a Shield for an extended amount of time as to not stop garbage collection.

fn repin_after<F, R>(&mut self, f: F) -> R where
    F: FnOnce() -> R, 

Attempt to synchronize the current thread like Shield::repin but executing a closure during the time the Shield is temporarily deactivated.

fn retire<F>(&self, f: F) where
    F: FnOnce() + 'a, 

Schedule a closure for execution once no shield may hold a reference to an object unlinked with the current shield.

impl<'a> Sync for FullShield<'a>