Enum mlua::Error [−][src]
#[non_exhaustive]
pub enum Error {
Show 26 variants
SyntaxError {
message: StdString,
incomplete_input: bool,
},
RuntimeError(StdString),
MemoryError(StdString),
GarbageCollectorError(StdString),
SafetyError(StdString),
MemoryLimitNotAvailable,
MainThreadNotAvailable,
RecursiveMutCallback,
CallbackDestructed,
StackError,
BindError,
ToLuaConversionError {
from: &'static str,
to: &'static str,
message: Option<StdString>,
},
FromLuaConversionError {
from: &'static str,
to: &'static str,
message: Option<StdString>,
},
CoroutineInactive,
UserDataTypeMismatch,
UserDataDestructed,
UserDataBorrowError,
UserDataBorrowMutError,
MetaMethodRestricted(StdString),
MetaMethodTypeError {
method: StdString,
type_name: &'static str,
message: Option<StdString>,
},
MismatchedRegistryKey,
CallbackError {
traceback: StdString,
cause: Arc<Error>,
},
PreviouslyResumedPanic,
SerializeError(StdString),
DeserializeError(StdString),
ExternalError(Arc<dyn StdError + Send + Sync>),
}
Expand description
Error type returned by mlua
methods.
Variants (Non-exhaustive)
This enum is marked as non-exhaustive
Syntax error while parsing Lua source code.
Fields of SyntaxError
RuntimeError(StdString)
Lua runtime error, aka LUA_ERRRUN
.
The Lua VM returns this error when a builtin operation is performed on incompatible types.
Among other things, this includes invoking operators on wrong types (such as calling or
indexing a nil
value).
Tuple Fields of RuntimeError
0: StdString
MemoryError(StdString)
Lua memory error, aka LUA_ERRMEM
The Lua VM returns this error when the allocator does not return the requested memory, aka it is an out-of-memory error.
Tuple Fields of MemoryError
0: StdString
GarbageCollectorError(StdString)
lua53
or lua52
only.Lua garbage collector error, aka LUA_ERRGCMM
.
The Lua VM returns this error when there is an error running a __gc
metamethod.
Tuple Fields of GarbageCollectorError
0: StdString
SafetyError(StdString)
Potentially unsafe action in safe mode.
Tuple Fields of SafetyError
0: StdString
Setting memory limit is not available.
This error can only happen when Lua state was not created by us and does not have the custom allocator attached.
Main thread is not available.
This error can only happen in Lua5.1/LuaJIT module mode, when module loaded within a coroutine.
These Lua versions does not have LUA_RIDX_MAINTHREAD
registry key.
A mutable callback has triggered Lua code that has called the same mutable callback again.
This is an error because a mutable callback can only be borrowed mutably once.
Either a callback or a userdata method has been called, but the callback or userdata has been destructed.
This can happen either due to to being destructed in a previous __gc, or due to being
destructed from exiting a Lua::scope
call.
Not enough stack space to place arguments to Lua functions or return values from callbacks.
Due to the way mlua
works, it should not be directly possible to run out of stack space
during normal use. The only way that this error can be triggered is if a Function
is
called with a huge number of arguments, or a rust callback returns a huge number of return
values.
Too many arguments to Function::bind
A Rust value could not be converted to a Lua value.
Fields of ToLuaConversionError
A Lua value could not be converted to the expected Rust type.
Fields of FromLuaConversionError
Thread::resume
was called on an inactive coroutine.
A coroutine is inactive if its main function has returned or if an error has occurred inside the coroutine.
Thread::status
can be used to check if the coroutine can be resumed without causing this
error.
An AnyUserData
is not the expected type in a borrow.
This error can only happen when manually using AnyUserData
, or when implementing
metamethods for binary operators. Refer to the documentation of UserDataMethods
for
details.
An AnyUserData
borrow failed because it has been destructed.
This error can happen either due to to being destructed in a previous __gc, or due to being
destructed from exiting a Lua::scope
call.
An AnyUserData
immutable borrow failed because it is already borrowed mutably.
This error can occur when a method on a UserData
type calls back into Lua, which then
tries to call a method on the same UserData
type. Consider restructuring your API to
prevent these errors.
An AnyUserData
mutable borrow failed because it is already borrowed.
This error can occur when a method on a UserData
type calls back into Lua, which then
tries to call a method on the same UserData
type. Consider restructuring your API to
prevent these errors.
MetaMethodRestricted(StdString)
A MetaMethod
operation is restricted (typically for __gc
or __metatable
).
Tuple Fields of MetaMethodRestricted
0: StdString
A MetaMethod
(eg. __index
or __newindex
) has invalid type.
A RegistryKey
produced from a different Lua state was used.
A Rust callback returned Err
, raising the contained Error
as a Lua error.
Fields of CallbackError
A Rust panic that was previously resumed, returned again.
This error can occur only when a Rust panic resumed previously was recovered and returned again.
SerializeError(StdString)
serialize
only.Serialization error.
Tuple Fields of SerializeError
0: StdString
DeserializeError(StdString)
serialize
only.Deserialization error.
Tuple Fields of DeserializeError
0: StdString
A custom error.
This can be used for returning user-defined errors from callbacks.
Returning Err(ExternalError(...))
from a Rust callback will raise the error as a Lua
error. The Rust code that originally invoked the Lua code then receives a CallbackError
,
from which the original error (and a stack traceback) can be recovered.
Implementations
Trait Implementations
Raised when there is general error when deserializing a type. Read more
Raised when a Deserialize
receives a type different from what it was
expecting. Read more
Raised when a Deserialize
receives a value of the right type but that
is wrong for some other reason. Read more
Raised when deserializing a sequence or map and the input data contains too many or too few elements. Read more
Raised when a Deserialize
enum type received a variant with an
unrecognized name. Read more
Raised when a Deserialize
struct type received a field with an
unrecognized name. Read more
Raised when a Deserialize
struct type expected to receive a required
field with a particular name but that field was not present in the
input. Read more
Raised when a Deserialize
struct type received more than one of the
same field. Read more
Performs the conversion.
Auto Trait Implementations
impl !RefUnwindSafe for Error
impl !UnwindSafe for Error
Blanket Implementations
Mutably borrows from an owned value. Read more