Struct CollectOptions

#[non_exhaustive]
pub struct CollectOptions {
    pub old_gen_threshold: usize,
    pub kind: CollectionType,
}

Provides settings which control how cycle-collection is performed.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

old_gen_threshold: usize

The number of times a pointer may be seen in the young gen before moving it to the old gen for a full tracing collection. Setting this to zero will cause all pointers to move to the old gen if they cannot be immediately cleaned up.

kind: CollectionType

The kind of collection to perform, e.g. just the young gen, or full tracing of both old & young gen.

Implementations

impl CollectOptions

pub const DEFAULT: Self

The default options for cycle collection. Items remain in the young gen for 5 cycles, and both old and young gen will be process for each collection. These options will be used when calling collect

pub const TRACE_AND_COLLECT_ALL: Self

Forces tracing collection for all items currently awaiting cleanup.

pub const YOUNG_ONLY: Self

Only runs collection for the young generation. This will still move old items to the old gen.

pub const fn set_kind(self, kind: CollectionType) -> Self

Alter the CollectionType performed when calling collect_with_options.

pub const fn set_old_gen_threshold(self, threshold: usize) -> Self

Alter the number of times an item may be seen in the young generation before being moved to the old generation and traced.

Trait Implementations

impl Clone for CollectOptions

fn clone(&self) -> CollectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectOptions

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

Formats the value using the given formatter.

impl Default for CollectOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CollectOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for CollectOptions

impl Eq for CollectOptions

impl StructuralPartialEq for CollectOptions