Skip to main content

GcState

Enum GcState 

Source
pub enum GcState {
    Pause,
    Propagate,
    EnterAtomic,
    Atomic,
    SweepAllGc,
    SweepFinObj,
    SweepToBeFnz,
    SweepEnd,
    CallFin,
}
Expand description

Phases of the incremental collection cycle.

The state machine matches a simplified subset of C-Lua’s lgc.c FSM and is driven by Heap::incremental_step_with_post_mark.

Transitions:

  • PausePropagate (on first step: reset colors, trace roots).
  • PropagateEnterAtomic (when the gray queue empties).
  • EnterAtomicAtomic (atomic phase is about to run).
  • AtomicSweepAllGc (post-mark hook has run; sweep cursor is initialized).
  • SweepAllGcSweepFinObj (allgc sweep cursor reached the end).
  • SweepFinObjSweepToBeFnz (finobj sweep cursor reached the end).
  • SweepToBeFnzSweepEnd (tobefnz sweep cursor reached the end).
  • SweepEndCallFin (finish sweep bookkeeping).
  • CallFinPause (cycle is complete).

Collecting is kept as a compatibility alias for the old API (used by barrier) — it means “anything but Pause.”

Variants§

§

Pause

§

Propagate

§

EnterAtomic

§

Atomic

§

SweepAllGc

§

SweepFinObj

§

SweepToBeFnz

§

SweepEnd

§

CallFin

Implementations§

Source§

impl GcState

Source

pub fn is_pause(self) -> bool

Source

pub fn is_propagate(self) -> bool

Source

pub fn is_invariant(self) -> bool

Source

pub fn is_sweep(self) -> bool

Trait Implementations§

Source§

impl Clone for GcState

Source§

fn clone(&self) -> GcState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for GcState

Source§

impl Debug for GcState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for GcState

Source§

impl PartialEq for GcState

Source§

fn eq(&self, other: &GcState) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for GcState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.