pub struct Cancelled;Expand description
The error a cancellation raises in Lua.
The cancel hook and cancellable raise
mlua::Error::external(Cancelled). Rust recognises it by value, with
mlua::Error::downcast_ref, which walks the CallbackError /
WithContext / BadArgument chain down to the ExternalError:
use mlua_isle::Cancelled;
fn is_cancel(e: &mlua::Error) -> bool {
e.downcast_ref::<Cancelled>().is_some()
}
assert!(is_cancel(&mlua::Error::external(Cancelled)));
assert!(!is_cancel(&mlua::Error::runtime("cancelled")));Lua code sees it as an error value (a userdata whose tostring is
cancelled plus a traceback); the task library’s
task.is_cancelled(err) is true for it (see the task library).
A host function that wants to report a cancel it observed itself can
return Err(mlua::Error::external(Cancelled)).
Trait Implementations§
impl Copy for Cancelled
impl Eq for Cancelled
Source§impl Error for Cancelled
impl Error for Cancelled
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
👎Deprecated since 1.42.0:
use the Display impl or to_string()
impl StructuralPartialEq for Cancelled
Auto Trait Implementations§
impl Freeze for Cancelled
impl RefUnwindSafe for Cancelled
impl Send for Cancelled
impl Sync for Cancelled
impl Unpin for Cancelled
impl UnsafeUnpin for Cancelled
impl UnwindSafe for Cancelled
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<E> ExternalError for E
impl<E> ExternalError for E
fn into_lua_err(self) -> Error
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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