Struct AmountReturned 

pub struct AmountReturned(/* private fields */);

Simple wrapper that tells Lua how many values a CFunction is intending to return.

Without this wrapper, Lua would willingly attempt to return as many values as you say, which can easily go beyond the stack and result in undefined behavior.

This wrapper can only be (safely) created by LuaState, which will check if the amount is valid before returning the AmountReturned (see LuaState::finish).

Implementations

impl AmountReturned

pub const NONE: Self

Tells Lua that no values are intended to be returned.

Always safe to use since nothing gets popped.

pub const unsafe fn unchecked(amount: i32) -> Self

Wraps amount around an AmountReturned, without doing any checks.

Safety

amount must not be higher than the amount of values the Lua stack is holding at the time of returning.