pub struct Error { /* private fields */ }Expand description
An error that crosses the FFI boundary, with a kind, a message and a backtrace.
An Error raised in another language arrives in Rust as an Err, and one
returned from a Rust Function is raised in the caller’s
language. Create one with bail! or
ensure!, which also record the source location.
§Examples
use tvm_ffi::{bail, Result, VALUE_ERROR};
fn parse_digit(c: char) -> Result<u32> {
match c.to_digit(10) {
Some(digit) => Ok(digit),
None => bail!(VALUE_ERROR, "not a digit: {:?}", c),
}
}
let error = parse_digit('x').unwrap_err();
assert_eq!(error.kind(), VALUE_ERROR);
assert_eq!(error.message(), "not a digit: 'x'");An Error is Send + Sync, so a Result can cross threads.
Implementations§
Source§impl Error
impl Error
Sourcepub fn from_panic(payload: Box<dyn Any + Send>) -> Self
pub fn from_panic(payload: Box<dyn Any + Send>) -> Self
The InternalError for a panic caught at an FFI boundary, where unwinding
into the caller would abort the process. The message is the panic’s, when it
is a string.
use tvm_ffi::{Error, INTERNAL_ERROR};
let payload = std::panic::catch_unwind(|| panic!("bad state")).unwrap_err();
let error = Error::from_panic(payload);
assert_eq!(error.kind(), INTERNAL_ERROR);
assert_eq!(error.message(), "panicked: bad state");Sourcepub fn downcast_failed<B: AnyCompatible>(source: impl ObjectRefCore) -> Self
pub fn downcast_failed<B: AnyCompatible>(source: impl ObjectRefCore) -> Self
The TypeError for a reference that downcast
handed back because it is not a B, naming both types.
use tvm_ffi::{object::ObjectRef, Array, Error, ObjectRefCore, TYPE_ERROR};
let object: ObjectRef = Array::from_vec(vec![1_i64]).into();
let error = object.downcast::<Array<f64>>().map_err(Error::downcast_failed::<Array<f64>>);
assert_eq!(error.unwrap_err().kind(), TYPE_ERROR);Sourcepub fn new(kind: ErrorKind<'_>, message: &str) -> Self
pub fn new(kind: ErrorKind<'_>, message: &str) -> Self
Create an error with an empty backtrace.
Prefer format_err! or bail!,
which also record the source location. Add the other parts with
with_backtrace,
with_cause and
with_extra_context.
§Arguments
kind- The kind of the error, such asVALUE_ERROR.message- The message of the error.
§Returns
The error.
Sourcepub fn with_cause(self, cause: &Error) -> Self
pub fn with_cause(self, cause: &Error) -> Self
Set cause as the error that caused this one, the
cause_chain. The error is updated in place when
it is not shared, and copied otherwise.
use tvm_ffi::{Error, RUNTIME_ERROR, VALUE_ERROR};
let cause = Error::new(VALUE_ERROR, "bad input");
let error = Error::new(RUNTIME_ERROR, "load failed").with_cause(&cause);
assert_eq!(error.cause_chain().unwrap().message(), "bad input");Sourcepub fn with_extra_context<T: ObjectRefCore + Send + Sync>(
self,
context: &T,
) -> Self
pub fn with_extra_context<T: ObjectRefCore + Send + Sync>( self, context: &T, ) -> Self
Set context as the extra_context, an object
of application-specific context; Send + Sync, since the error is.
The error is updated in place when it is not shared, and copied
otherwise.
Sourcepub fn from_raised() -> Self
pub fn from_raised() -> Self
Create a new error by moving from the error that the last failed FFI call
raised on this thread, as set by Error::set_raised. An associated
function rather than a constructor from a value: it takes the thread’s
state.
§Returns
The raised error.
§Panics
Panics if no error was raised.
Sourcepub fn set_raised(error: &Self)
pub fn set_raised(error: &Self)
Set error as the raised error of the calling thread, for the caller of
an extern "C" function, which then returns -1, to take with
Error::from_raised. An associated function rather than a method: it
changes the thread’s state, not error.
§Arguments
error- The error to set as raised.
Sourcepub fn backtrace(&self) -> &str
pub fn backtrace(&self) -> &str
Get the backtrace of the error.
It may be rewritten when the error is re-raised through another language: copy it to keep it across FFI calls.
§Returns
The backtrace, most recent call first.
Sourcepub fn cause_chain(&self) -> Option<&Error>
pub fn cause_chain(&self) -> Option<&Error>
The error that caused this one, the next link of the cause chain; the
same error that std::error::Error::source returns.
Sourcepub fn extra_context(&self) -> Option<&ObjectRef>
pub fn extra_context(&self) -> Option<&ObjectRef>
The application-specific context object, if present.
The context is shared with every thread the error reaches, so it must be safe to share; a context set by another language is the setter’s responsibility.
Sourcepub fn traceback_most_recent_call_last(&self) -> String
pub fn traceback_most_recent_call_last(&self) -> String
Get the traceback of the error in the order of most recent call last, as Python prints it.
§Returns
The traceback of the error.
Sourcepub fn with_backtrace(self, backtrace: &str) -> Self
pub fn with_backtrace(self, backtrace: &str) -> Self
Replace the backtrace, most recent call first. The error is updated in place when it is not shared, and copied otherwise.
Sourcepub fn with_appended_backtrace(self, backtrace: &str) -> Self
pub fn with_appended_backtrace(self, backtrace: &str) -> Self
Append the backtrace to the error.
attach_context! appends the current source
location this way. The error is updated in place when it is not shared, and
copied otherwise.
§Arguments
backtrace- The backtrace to append.
§Returns
The error with the appended backtrace.
Trait Implementations§
Source§impl Debug for Error
Formats the traceback, most recent call last, then the kind and the
message, as Python prints an exception; unwrap and expect print it.
impl Debug for Error
Formats the traceback, most recent call last, then the kind and the
message, as Python prints an exception; unwrap and expect print it.
Source§impl Display for Error
Formats the kind and the message, such as ValueError: bad x, as C++
what(); Debug adds the traceback.
impl Display for Error
Formats the kind and the message, such as ValueError: bad x, as C++
what(); Debug adds the traceback.
Source§impl DowncastRefFromAny for Error
impl DowncastRefFromAny for Error
Source§impl Error for Error
impl Error for Error
Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Source§impl ObjectRefAnyCompatible for Error
impl ObjectRefAnyCompatible for Error
Source§fn extra_check(obj: &Self::ContainerType) -> bool
fn extra_check(obj: &Self::ContainerType) -> bool
obj, an instance of ContainerType, is a value of Self.
Every strict and converting cast checks it, after the object type.Source§fn convert_fallback(value: AnyView<'_>) -> Option<Self>
fn convert_fallback(value: AnyView<'_>) -> Option<Self>
Self object, such as an integer that
stands for a constant; None rejects it. Only converting casts (TryFrom<Any>,
typed function arguments) call it; downcast_ref, downcast and
match_any! never do.Source§fn custom_type_str() -> String
fn custom_type_str() -> String
AnyCompatible::type_str.Source§fn custom_mismatch_type_info(value: AnyView<'_>) -> String
fn custom_mismatch_type_info(value: AnyView<'_>) -> String
value in conversion errors; by default its
runtime type key. See AnyCompatible::get_mismatch_type_info.Source§impl ObjectRefCore for Error
impl ObjectRefCore for Error
Source§type ContainerType = ErrorObj
type ContainerType = ErrorObj
Source§fn data(this: &Self) -> &ObjectArc<Self::ContainerType>
fn data(this: &Self) -> &ObjectArc<Self::ContainerType>
Source§fn into_data(this: Self) -> ObjectArc<Self::ContainerType>
fn into_data(this: Self) -> ObjectArc<Self::ContainerType>
Source§unsafe fn from_data(data: ObjectArc<Self::ContainerType>) -> Self
unsafe fn from_data(data: ObjectArc<Self::ContainerType>) -> Self
Source§fn same_as<Other: ObjectRefCore>(&self, other: &Other) -> bool
fn same_as<Other: ObjectRefCore>(&self, other: &Other) -> bool
Source§fn type_key(&self) -> &'static str
fn type_key(&self) -> &'static str
"ffi.Array", as C++ ObjectRef::GetTypeKey.Source§fn is<T: AnyCompatible>(&self) -> bool
fn is<T: AnyCompatible>(&self) -> bool
T as is, such as a subtype or a container
whose elements are checked too, by the strict check of
downcast, without a reference count change.
See also crate::Any::is.Source§impl PackedCallArg for Error
impl PackedCallArg for Error
Source§impl<'a> PackedCallArg for &'a Error
impl<'a> PackedCallArg for &'a Error
impl Send for Error
impl Sync for Error
impl TypeSubsumes<Error> for ObjectRef
Auto Trait Implementations§
impl Forget for Error
impl Freeze for Error
impl Move for Error
impl RefUnwindSafe for Error
impl Unpin for Error
impl UnsafeUnpin for Error
impl UnwindSafe for Error
Blanket Implementations§
Source§impl<T> AnyCompatible for Twhere
T: ObjectRefAnyCompatible,
impl<T> AnyCompatible for Twhere
T: ObjectRefAnyCompatible,
const MATCH_ANY_EXACT: bool = const MATCH_ANY_EXACT: bool = <T as ObjectRefAnyCompatible>::MATCH_ANY_EXACT && <T::ContainerType as ObjectCore>::TYPE_FINAL;
fn match_any_exact_type_index() -> i32
Source§unsafe fn is_undefined(field: *const T) -> bool
unsafe fn is_undefined(field: *const T) -> bool
field, which holds a value of this type or all-zero bytes,
holds all-zero bytes that are no value of this type, as a null object
reference, a string of type index None or a zero device type: a field
that a creator left undefined for reflection to set. An undefined field
is no value; a nullable reference is Option<T>, whose None is a
defined value. Read moreSource§unsafe fn copy_to_any_view(src: &T, data: &mut TVMFFIAny)
unsafe fn copy_to_any_view(src: &T, data: &mut TVMFFIAny)
Source§unsafe fn move_to_any(src: T, data: &mut TVMFFIAny)
unsafe fn move_to_any(src: T, data: &mut TVMFFIAny)
Source§unsafe fn check_any_strict(data: &TVMFFIAny) -> bool
unsafe fn check_any_strict(data: &TVMFFIAny) -> bool
Source§unsafe fn copy_from_any_view_after_check(data: &TVMFFIAny) -> T
unsafe fn copy_from_any_view_after_check(data: &TVMFFIAny) -> T
Self out of a cell that holds one, retaining any object. Read moreSource§unsafe fn move_from_any_after_check(data: &mut TVMFFIAny) -> T
unsafe fn move_from_any_after_check(data: &mut TVMFFIAny) -> T
Self out of an owning cell that holds one. Read moreSource§unsafe fn try_cast_from_any_view(data: &TVMFFIAny) -> Result<T, ()>
unsafe fn try_cast_from_any_view(data: &TVMFFIAny) -> Result<T, ()>
data into a Self by the FFI rules, such as an integer into a
float; Err if it does not convert. Read moreSource§fn get_mismatch_type_info(data: &TVMFFIAny) -> String
fn get_mismatch_type_info(data: &TVMFFIAny) -> String
data in conversion errors; by
default its runtime type key.Source§fn type_str() -> String
fn type_str() -> String
int,
ffi.String or Array<int>.