Struct w32_error::W32Error

#[must_use = "this `W32Error` is unhandled"]#[repr(transparent)]pub struct W32Error(_);

A Windows API error.

Methods

impl W32Error

pub const fn new(code: DWORD) -> Self

Wraps an arbitrary error code.

Examples

let error = W32Error::new(0);
println!("{}", error);

pub fn from_io_error(other: &Error) -> Option<Self>

Wraps the error code from an io::Error if it has one.

Examples

use std::io;
let io_error = io::Error::from_raw_os_error(0);
let opt = W32Error::from_io_error(&io_error);
assert_eq!(opt, Some(W32Error::new(0)));

pub fn last_thread_error() -> Self

Wraps the error code that is currently set for the calling thread.

This is equivalent to calling the Windows API function GetLastError and passing the return value to W32Error::new.

Examples

let error = W32Error::last_thread_error();
println!("{}", error);

pub const fn into_inner(self) -> DWORD

Returns the underlying error code wrapped by a W32Error.

Examples

assert_eq!(W32Error::new(0).into_inner(), 0);

Trait Implementations

impl Clone for W32Error

fn clone(&self) -> W32Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for W32Error

impl Debug for W32Error

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

Formats the value using the given formatter.

impl Display for W32Error

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

Formats the value using the given formatter.

impl Eq for W32Error

impl Error for W32Error

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<W32Error> for Error

fn from(other: W32Error) -> Self

Performs the conversion.

impl From<W32Error> for DWORD

fn from(other: W32Error) -> Self

Performs the conversion.

impl From<u32> for W32Error

fn from(other: DWORD) -> Self

Performs the conversion.

impl Hash for W32Error

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for W32Error

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<W32Error> for W32Error

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

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

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

This method tests for !=.

impl PartialOrd<W32Error> for W32Error

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for W32Error

impl StructuralPartialEq for W32Error

impl TryFrom<Error> for W32Error

type Error = TryFromIoError

The type returned in the event of a conversion error.

fn try_from(other: Error) -> Result<Self, Self::Error>

Performs the conversion.