Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub grace: Duration,
    pub preempt_every: Option<u32>,
}
Expand description

Settings of a VM. One per VM, read and written through Vm (Vm::attach, Vm::config, Vm::set_config).

Fields§

§grace: Duration

How long a cancelled coroutine request or task may keep running to finish its cleanup before it is dropped.

On cancel, the coroutine first receives the cancellation as a Lua error (from the cancel hook while it runs, or from an async function wrapped with cancellable while it awaits). That error unwinds normally, so __close handlers run and may await. If the coroutine has not finished when the grace period ends, it is dropped: the awaited Rust future is released, and pending __close handlers run without being able to yield (a Lua 5.4 restriction).

The grace period is one deadline for the cancelled request or task and every task it spawned, transitively: a task started during cleanup (from a __close handler, say) gets the time that remains, not a fresh grace period.

Default: zero (drop at once).

§preempt_every: Option<u32>

Yield the running coroutine request or task every this many cancel checks (a check runs every 1000 instructions), so that other tasks on the same thread, including one that cancels it, get to run while it is in a CPU loop.

Only the coroutine that the crate created for the request or task is yielded, never a coroutine the Lua code created itself (that yield would reach the Lua code’s own coroutine.resume as a spurious yield). Code in a non-yieldable context (a metamethod, a C function boundary) is not yielded.

Yielding lets other tasks interleave at points the Lua code did not mark, so Lua code that updates shared state across such a point can observe changes made by another task.

Default: None (never preempt).

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Self

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 Config

Source§

impl Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl Eq for Config

Source§

impl PartialEq for Config

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Config

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.