Struct Error

pub struct Error { /* private fields */ }

A generic error capable of representing various error domains (types).

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl Error

pub fn as_ptr(&self) -> *mut GError

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GError) -> &Error

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut(ptr: &mut *mut GError) -> &mut Error

Borrows the underlying C value mutably.

impl Error

pub fn new<T>(error: T, message: &str) -> Error

where T: ErrorDomain,

Creates an error with supplied error enum variant and message.

pub fn with_domain(domain: Quark, code: i32, message: &str) -> Error

Creates an error with supplied error domain quark, code and message.

This is useful when you need to create an error with the same domain and code as an existing error but with a different message.

Examples

let original = Error::new(FileError::Failed, "Original message");
let modified = Error::with_domain(
    original.domain(),
    original.code(),
    "Modified message"
);

pub fn is<T>(&self) -> bool

where T: ErrorDomain,

Checks if the error domain matches T.

pub fn domain(&self) -> Quark

Returns the error domain quark

pub fn code(&self) -> i32

Returns the error code

pub fn matches<T>(&self, err: T) -> bool

where T: ErrorDomain,

Checks if the error matches the specified domain and error code.

pub fn kind<T>(&self) -> Option<T>

where T: ErrorDomain,

Tries to convert to a specific error enum.

Returns Some if the error belongs to the enum’s error domain and None otherwise.

Examples

if let Some(file_error) = error.kind::<FileError>() {
    match file_error {
        FileError::Exist => ...
        FileError::Isdir => ...
        ...
    }
}

pub fn message(&self) -> &str

Returns the error message

Most of the time you can simply print the error since it implements the Display trait, but you can use this method if you need to have the message as a &str.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Copies the boxed type with the type-specific copy function.

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 Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.

impl From<Cancelled> for Error

fn from(_: Cancelled) -> Error

Converts to this type from the input type.

impl From<Error> for CvtError

fn from(err: Error) -> CvtError

Converts to this type from the input type.

impl From<Error> for Value

fn from(o: Error) -> Value

Converts to this type from the input type.

impl From<Infallible> for Error

fn from(e: Infallible) -> Error

Converts to this type from the input type.

impl HasParamSpec for Error

type ParamSpec = ParamSpecBoxed

type SetValue = Error

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecBoxedBuilder<'_, Error>

fn param_spec_builder() -> <Error as HasParamSpec>::BuilderFn

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 Ord for Error

fn cmp(&self, other: &Error) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for Error

fn partial_cmp(&self, other: &Error) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Error

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Error

impl Send for Error

impl StructuralPartialEq for Error

impl Sync for Error