Struct Error 

pub struct Error { /* private fields */ }

Implementations

impl Error

Manual extensions for the Error enum.

pub fn err(self) -> Result<(), Error>

Converts this Error into a Result<(), Error> which is Ok(()) if the given value is Error::OK.

This is a convenience method that may be used to convert this type into one that can be used with the try operator (?) for easy short circuiting of Godot Errors.

To assist with this, Result<(), Error> has a ToGodot implementation that turns it back into an Error on Godot’s side, so that it can be used as the return value of #[func] functions.

pub fn from_result(result: Result<(), Error>) -> Error

Creates an Error from a Result<(), Error>, the inverse of .err().

Ok(()) becomes Error::OK, and Err(e) becomes e.

impl Error

pub const OK: Error

pub const FAILED: Error

pub const ERR_UNAVAILABLE: Error

pub const ERR_UNCONFIGURED: Error

pub const ERR_UNAUTHORIZED: Error

pub const ERR_PARAMETER_RANGE_ERROR: Error

pub const ERR_OUT_OF_MEMORY: Error

pub const ERR_FILE_NOT_FOUND: Error

pub const ERR_FILE_BAD_DRIVE: Error

pub const ERR_FILE_BAD_PATH: Error

pub const ERR_FILE_NO_PERMISSION: Error

pub const ERR_FILE_ALREADY_IN_USE: Error

pub const ERR_FILE_CANT_OPEN: Error

pub const ERR_FILE_CANT_WRITE: Error

pub const ERR_FILE_CANT_READ: Error

pub const ERR_FILE_UNRECOGNIZED: Error

pub const ERR_FILE_CORRUPT: Error

pub const ERR_FILE_MISSING_DEPENDENCIES: Error

pub const ERR_FILE_EOF: Error

pub const ERR_CANT_OPEN: Error

pub const ERR_CANT_CREATE: Error

pub const ERR_QUERY_FAILED: Error

pub const ERR_ALREADY_IN_USE: Error

pub const ERR_LOCKED: Error

pub const ERR_TIMEOUT: Error

pub const ERR_CANT_CONNECT: Error

pub const ERR_CANT_RESOLVE: Error

pub const ERR_CONNECTION_ERROR: Error

pub const ERR_CANT_ACQUIRE_RESOURCE: Error

pub const ERR_CANT_FORK: Error

pub const ERR_INVALID_DATA: Error

pub const ERR_INVALID_PARAMETER: Error

pub const ERR_ALREADY_EXISTS: Error

pub const ERR_DOES_NOT_EXIST: Error

pub const ERR_DATABASE_CANT_READ: Error

pub const ERR_DATABASE_CANT_WRITE: Error

pub const ERR_COMPILATION_FAILED: Error

pub const ERR_METHOD_NOT_FOUND: Error

pub const ERR_LINK_FAILED: Error

pub const ERR_SCRIPT_FAILED: Error

pub const ERR_CYCLIC_LINK: Error

pub const ERR_INVALID_DECLARATION: Error

pub const ERR_DUPLICATE_SYMBOL: Error

pub const ERR_PARSE_ERROR: Error

pub const ERR_BUSY: Error

pub const ERR_SKIP: Error

pub const ERR_HELP: Error

pub const ERR_BUG: Error

pub const ERR_PRINTER_ON_FIRE: Error

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl EngineEnum for Error

fn try_from_ord(ord: i32) -> Option<Error>

fn ord(self) -> i32

Ordinal value of the enumerator, as specified in Godot. This is not necessarily unique.

fn as_str(&self) -> &'static str

The name of the enumerator, as it appears in Rust.

fn values() -> &'static [Error]

Returns a slice of distinct enum values.

fn all_constants() -> &'static [EnumConstant<Error>]

Returns metadata for all enum constants.

fn from_ord(ord: i32) -> Self

impl FromGodot for Error

fn try_from_godot( via: <Error as GodotConvert>::Via, ) -> Result<Error, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl GodotConvert for Error

type Via = i32

The type through which Self is represented in Godot.

fn godot_shape() -> GodotShape

Which “shape” this type has for property registration (e.g. builtin, enum, …).

impl Hash for Error

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToGodot for Error

type Pass = ByValue

Whether arguments of this type are passed by value or by reference.

fn to_godot(&self) -> <Error as GodotConvert>::Via

Converts this type to Godot representation, optimizing for zero-copy when possible.

fn to_godot_owned(&self) -> Self::Via

where Self::Via: Clone,

Converts this type to owned Godot representation.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Var for Error

type PubType = Error

Type used in generated Rust getters/setters for #[var(pub)].

fn var_get(field: &Error) -> <Error as GodotConvert>::Via

Get property value via FFI-level Via type. Called for internal (non-pub) getters registered with Godot.

fn var_set(field: &mut Error, value: <Error as GodotConvert>::Via)

Set property value via FFI-level Via type. Called for internal (non-pub) setters registered with Godot.

fn var_pub_get(field: &Error) -> <Error as Var>::PubType

Get property value as PubType. Called for #[var(pub)] getters exposed in Rust API.

fn var_pub_set(field: &mut Error, value: <Error as Var>::PubType)

Set property value as PubType. Called for #[var(pub)] setters exposed in Rust API.

impl Copy for Error

impl Element for Error

impl Eq for Error

impl Export for Error

impl StructuralPartialEq for Error