Struct flize::Collector

pub struct Collector { /* fields omitted */ }

The Collector acts like the central bookkeeper, it stores all the retired functions that are queued for execution along with information on what each participant is doing, Participants are pretty much always thread specific as of now but cross-thread participants may be added in the future. This information can be used to determine approximately when a participant last was in in a critical section and relevant shield history. The collector uses this information to determine when it is safe to execute a retired function.

Implementations

impl Collector

pub fn new() -> Self

pub fn thin_shield(&self) -> ThinShield<'_>

Creates a shield on the appropriate local given the current thread.

pub fn full_shield(&self) -> FullShield<'_>

pub fn local(&self) -> Local

Get the local for the current thread.

pub fn try_collect_light(&self) -> Result<usize, ()>

Attempt to advance the epoch and collect garbage. The result represents whether or not the attempt to advance the global epoch was successful and if it was the integer is how many retired functions were executed.

Trait Implementations

impl Default for Collector

fn default() -> Self

Returns the "default value" for a type.

impl Send for Collector

impl Sync for Collector