Struct gc_arena::ArenaParameters

pub struct ArenaParameters { /* fields omitted */ }

Methods

impl ArenaParameters

pub fn set_pause_factor(self, pause_factor: f64) -> ArenaParameters

The garbage collector will wait until the live size reaches + * pause_multiplier before beginning a new collection. Must be >= 0.0, setting this to 0.0 causes the collector to never sleep longer than min_sleep before beginning a new collection.

pub fn set_timing_factor(self, timing_factor: f64) -> ArenaParameters

The garbage collector will try and finish a collection by the time * timing_factor additional bytes are allocated. For example, if the collection is started when the arena has 100KB live data, and the timing_multiplier is 1.0, the collector should finish its final phase of this collection after another 100KB has been allocated. Must be

= 0.0, setting this to 0.0 causes the collector to behave like a stop-the-world collector.

pub fn set_min_sleep(self, min_sleep: usize) -> ArenaParameters

The minimum allocation amount during sleep before the arena starts collecting again. This is mostly useful when the heap is very small to prevent rapidly restarting collections.

Trait Implementations

impl Default for ArenaParameters

Creates a default ArenaParameters with pause_factor set to 0.5, timing_factor set to 1.5, and min_sleep set to 4096.

fn default() -> ArenaParameters

Returns the "default value" for a type.

impl Clone for ArenaParameters

fn clone(&self) -> ArenaParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArenaParameters

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

Formats the value using the given formatter.