godot::prelude

Struct ConvertError

pub struct ConvertError { /* private fields */ }
Expand description

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>) -> ConvertError

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) -> ConvertError
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) -> ConvertError
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<(), Error>

Formats the value using the given formatter. Read more
§

impl Default for ConvertError

§

fn default() -> ConvertError

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<(), Error>

Formats the value using the given formatter. Read more
§

impl Error for ConvertError

§

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

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

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

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

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. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.