Struct rust_cc::config::Config

pub struct Config { /* private fields */ }

Available on crate feature auto-collect only.

The configuration of the garbage collector.

Implementations

impl Config

pub fn auto_collect(&self) -> bool

Returns true if collections can be automatically started, false otherwise.

pub fn set_auto_collect(&mut self, auto_collect: bool)

Sets whether collections can be automatically started.

pub fn adjustment_percent(&self) -> f64

Returns the threshold adjustment percent.

See the module-level documentation for more details.

pub fn set_adjustment_percent(&mut self, percent: f64)

Sets the threshold adjustment percent.

See the module-level documentation for more details.

Panics

Panics if the provided percent isn’t between 0 and 1 (included).

pub fn buffered_objects_threshold(&self) -> Option<NonZeroUsize>

Returns the buffered-objects threshold (see Cc::mark_alive).

Returns None if this parameter isn’t used to start a collection.

See the module-level documentation for more details.

pub fn set_buffered_objects_threshold( &mut self, threshold: Option<NonZeroUsize>, )

Sets the buffered-objects threshold (see Cc::mark_alive).

If the provided threshold is None, then this parameter will not be used to start a collection.

See the module-level documentation for more details.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.