Struct windows::HRESULT

#[repr(transparent)]
#[must_use]
pub struct HRESULT(pub u32);

A primitive error code value returned by most COM functions.

Implementations

impl HRESULT

pub fn is_ok(self) -> bool

Returns true if self is a success code.

pub fn is_err(self) -> bool

Returns true if self is a failure code.

pub fn unwrap(self)

Asserts that self is a success code.

This will invoke the panic! macro if self is a failure code and display the HRESULT value for diagnostics.

pub fn ok(self) -> Result<()>

Converts the HRESULT to Result<()>.

pub fn and_some<T: Interface>(self, some: Option<T>) -> Result<T>

Returns the Option as a Result if the option is a Some value, returning a suitable error if not.

pub fn and_then<F, T>(self, op: F) -> Result<T> where
    F: FnOnce() -> T, 

Calls op if self is a success code, otherwise returns HRESULT converted to Result<T>.

pub unsafe fn from_abi<T: Abi>(self, abi: T::Abi) -> Result<T>

If the Result is Ok converts the T::Abi into T.

pub fn from_thread() -> Self

Retrieves the error code stored on the calling thread.

pub fn from_win32(error: u32) -> Self

Creates a failure code with the provided win32 error code.

This is equivalent to HRESULT_FROM_WIN32.

pub fn message(&self) -> String

The error message describing the error.

Trait Implementations

impl Abi for HRESULT

type Abi = Self

The abi representation of the implementing type.

fn abi(&self) -> Self::Abi

Casts the Rust object to its ABI type without copying the object.

fn set_abi(&mut self) -> *mut Self::Abi

Returns a pointer for setting the object’s value via an ABI call.

unsafe fn from_abi(abi: Self::Abi) -> Result<Self>

Casts the ABI representation to a Rust object by taking ownership of the bits.

fn drop_param(_: &mut Param<'_, Self>)

impl Clone for HRESULT

fn clone(&self) -> HRESULT

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HRESULT

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

Formats the value using the given formatter.

impl Default for HRESULT

fn default() -> HRESULT

Returns the “default value” for a type.

impl From<Error> for HRESULT

fn from(error: Error) -> Self

Performs the conversion.

impl From<HRESULT> for Error

fn from(code: HRESULT) -> Self

Performs the conversion.

impl<T> From<Result<T, Error>> for HRESULT

fn from(result: Result<T>) -> Self

Performs the conversion.

impl PartialEq<HRESULT> for HRESULT

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for HRESULT

impl StructuralPartialEq for HRESULT