Struct GcInterpreterState 

pub struct GcInterpreterState {
    pub generations: [GcGeneration; 3],
    pub garbage: PyMutex<Vec<PyObjectRef>>,
    pub py_garbage: PyListRef,
    pub py_callbacks: PyListRef,
    /* private fields */
}

Per-interpreter garbage collector state (≈ PyInterpreterState.gc).

The generation lists are process-wide (see GcState); what an interpreter owns is the policy applied to them and the results — which objects its collections consider, whether they run automatically, and where uncollectable objects end up.

Fields

generations: [GcGeneration; 3]

Per-generation thresholds and statistics.

garbage: PyMutex<Vec<PyObjectRef>>

Uncollectable objects saved by this interpreter’s collections, drained into py_garbage by gc.collect().

py_garbage: PyListRef

gc.garbage

py_callbacks: PyListRef

gc.callbacks

Implementations

impl GcInterpreterState

pub fn new(ctx: &Context) -> Self

pub fn is_enabled(&self) -> bool

Check if GC is enabled.

Relaxed, like GcGeneration::threshold: it is read once per allocation, and an allocation racing gc.disable() may use either value.

pub fn enable(&self)

Enable GC

pub fn disable(&self)

Disable GC

pub fn get_debug(&self) -> GcDebugFlags

Get debug flags

pub fn set_debug(&self, flags: GcDebugFlags)

Set debug flags

pub fn get_threshold(&self) -> (u32, u32, u32)

Get thresholds for all generations

pub fn set_threshold(&self, t0: u32, t1: Option<u32>, t2: Option<u32>)

Set thresholds

pub fn get_stats(&self) -> [GcStats; 3]

Get statistics for all generations

pub fn collect(&self, generation: usize) -> CollectResult

Perform garbage collection on the given generation

pub fn collect_force(&self, generation: usize) -> CollectResult

Force collection even if GC is disabled (for manual gc.collect() calls)

pub fn get_objects(&self, generation: Option<i32>) -> Vec<PyObjectRef>

The tracked objects this interpreter can reach (for gc.get_objects).

pub fn freeze(&self)

Move the objects this interpreter could collect into the permanent generation.

pub fn unfreeze(&self)

Move them back out of it.

Trait Implementations

impl Drop for GcInterpreterState

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.