Struct Error 

pub struct Error { /* private fields */ }

Represents an error in the WSL plugin system.

This struct encapsulates:

• An error code (HRESULT) derived from Windows APIs.
• An optional error message (OsString).

Implementations

impl Error

pub fn new(code: HRESULT, message: Option<&OsStr>) -> Self

Creates a new error with a specified code and optional message.

Arguments

• code: The HRESULT representing the error code.
• message: An optional error message.

Returns

A new instance of Error.

pub fn with_code(code: HRESULT) -> Self

Creates an error with only an error code.

Arguments

• code: The HRESULT representing the error code.

Returns

A new instance of Error without an associated message.

pub fn with_message(code: HRESULT, message: &OsStr) -> Self

Creates an error with both a code and a message.

Arguments

• code: The HRESULT representing the error code.
• message: An associated error message.

Returns

A new instance of Error.

pub const fn code(&self) -> HRESULT

Retrieves the error code as an HRESULT.

Returns

The error code wrapped in an HRESULT.

pub fn message(&self) -> Option<&OsStr>

Retrieves the optional error message.

Returns

A reference to the error message, if present.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the error for display.

If an error message is present, it is included in the output. Otherwise, only the error code is displayed.

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

fn from(value: Error) -> Self

Converts the Error into a WinError.

Returns

A WinError constructed from the error’s code and message.

impl From<Error> for Error

fn from(value: WinError) -> Self

Converts a WinError into an Error.

Returns

An Error containing the code and message from the WinError.

impl From<Error> for Error

fn from(value: RequireUpdateError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(value: ApiError) -> Self

Converts to this type from the input type.

impl From<HRESULT> for Error

fn from(value: HRESULT) -> Self

Converts an HRESULT into an Error.

Returns

An Error containing the HRESULT as its code.