Struct ConvertError

pub struct ConvertError { /* private fields */ }

Represents errors that can occur when converting values from Godot.

To create user-defined errors, you can use ConvertError::default() or ConvertError::new("message").

Implementations

impl ConvertError

pub fn new(user_message: impl Into<String>) -> Self

Construct with a user-defined message.

If you don’t need a custom message, consider using ConvertError::default() instead.

pub fn with_error<E>(error: E) -> Self

where E: Into<Box<dyn Error + Send + Sync>>,

Create a new custom error wrapping an Error.

pub fn with_error_value<E, V>(error: E, value: V) -> Self

where E: Into<Box<dyn Error + Send + Sync>>, V: ToGodot,

Create a new custom error wrapping an Error and the value that failed to convert.

pub fn cause(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

Returns the rust-error that caused this error, if one exists.

pub fn value(&self) -> Option<&Variant>

Returns a reference of the value that failed to convert, if one exists.

pub fn into_erased(self) -> impl Error + Send + Sync

Converts error into generic error type. It is useful to send error across thread. Do note that some data might get lost during conversion.

Trait Implementations

impl Debug for ConvertError

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

Formats the value using the given formatter.

impl Default for ConvertError

fn default() -> Self

Create a custom error, without any description.

If you need a custom message, consider using ConvertError::new("message") instead.

impl Display for ConvertError

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

Formats the value using the given formatter.

impl Error for ConvertError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.