Struct Error 

pub struct Error { /* private fields */ }

A Windows error code with optional COM error information.

Extended error information

By default, Error retains an IErrorInfo object when available. This may include a message, source, and WinRT stack trace.

Set RUSTFLAGS=--cfg=windows_slim_errors to omit IErrorInfo. This reduces Error to the four-byte HRESULT and removes its Drop implementation, but discards extended information.

This is controlled by a --cfg option rather than a Cargo feature because this compilation option sets a policy that applies to an entire graph of crates. Individual crates that take a dependency on the windows-result crate are not in a good position to decide whether they want slim errors or full errors. Cargo features are meant to be additive, but specifying the size and contents of Error is not a feature so much as a whole-program policy decision.

References

• IErrorInfo

Implementations

impl Error

pub const fn empty() -> Error

Creates an error object without any failure information.

pub fn new<T>(code: HRESULT, message: T) -> Error

where T: AsRef<str>,

Creates a new error object, capturing the stack and other information about the point of failure.

pub fn from_hresult(code: HRESULT) -> Error

Creates a new error object with an error code, but without additional error information.

pub fn from_thread() -> Error

Creates a new Error from the Win32 error code returned by GetLastError().

pub const fn code(&self) -> HRESULT

The error code describing the error.

pub fn message(&self) -> String

The error message describing the error.

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

The error object describing the 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, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

Available on crate feature std only.

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

fn from(error: Error) -> HRESULT

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature std only.

fn from(from: Error) -> Error

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(_: FromUtf8Error) -> Error

Converts to this type from the input type.

impl From<FromUtf16Error> for Error

fn from(_: FromUtf16Error) -> Error

Converts to this type from the input type.

impl From<HRESULT> for Error

fn from(code: HRESULT) -> Error

Converts to this type from the input type.

impl From<NTSTATUS> for Error

fn from(value: NTSTATUS) -> Error

Converts to this type from the input type.

impl From<RPC_STATUS> for Error

fn from(value: RPC_STATUS) -> Error

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(_: TryFromIntError) -> Error

Converts to this type from the input type.

impl From<WIN32_ERROR> for Error

fn from(value: WIN32_ERROR) -> Error

Converts to this type from the input type.

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

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.