Struct GcIncParams 

#[non_exhaustive]
pub struct GcIncParams {
    pub pause: Option<c_int>,
    pub goal: Option<c_int>,
    pub step_multiplier: Option<c_int>,
    pub step_size: Option<c_int>,
}

Tuning parameters for the incremental GC collector.

More information can be found in the Lua documentation.

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.

pause: Option<c_int>

Available on non-crate feature luau only.

Pause between successive GC cycles, expressed as a percentage of live memory.

goal: Option<c_int>

Available on crate feature luau only.

Target heap size as a percentage of live data, controlling how aggressively the GC reclaims memory (LUA_GCSETGOAL).

step_multiplier: Option<c_int>

GC work performed per unit of memory allocated.

step_size: Option<c_int>

Available on crate features lua55 or lua54 or luau only.

Granularity of each GC step (see Lua reference for details).

Implementations

impl GcIncParams

pub fn pause(self, v: c_int) -> Self

Available on non-crate feature luau only.

Sets the pause parameter.

pub fn goal(self, v: c_int) -> Self

Available on crate feature luau only.

Sets the goal parameter.

pub fn step_multiplier(self, v: c_int) -> Self

Sets the step_multiplier parameter.

pub fn step_size(self, v: c_int) -> Self

Available on crate features lua55 or lua54 or luau only.

Sets the step_size parameter.

Trait Implementations

impl Clone for GcIncParams

fn clone(&self) -> GcIncParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GcIncParams

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

Formats the value using the given formatter.

impl Default for GcIncParams

fn default() -> GcIncParams

Returns the “default value” for a type.

impl Copy for GcIncParams