Skip to main content

GcIncParams

Struct GcIncParams 

Source
pub struct GcIncParams { /* private fields */ }
Expand description

Parameters for Luau’s incremental GC, mirroring mlua::state::GcIncParams.

On Luau the tunables are the goal (heap-growth target percentage), the step multiplier, and the step size (KB). (Lua 5.x’s pause is replaced by goal here — see GcIncParams::goal.)

Implementations§

Source§

impl GcIncParams

Source

pub fn goal(self, goal: u32) -> Self

The heap-growth goal (percentage). Luau’s analog of Lua’s pause. Mirrors mlua::state::GcIncParams::goal.

Source

pub fn step_multiplier(self, mul: u32) -> Self

The GC step multiplier (percentage of allocation to collect per step). Mirrors mlua::state::GcIncParams::step_multiplier.

Source

pub fn step_size(self, size: u32) -> Self

The GC step size in KB. Mirrors mlua::state::GcIncParams::step_size.

Trait Implementations§

Source§

impl Clone for GcIncParams

Source§

fn clone(&self) -> GcIncParams

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for GcIncParams

Source§

impl Debug for GcIncParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GcIncParams

Source§

fn default() -> GcIncParams

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSend for T

Source§

impl<T> MaybeSync for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.