Struct getrandom::Error

pub struct Error(_);

A small and no_std compatible error type.

The [Error::raw_os_error()] will indicate if the error is from the OS, and if so, which error code the OS gave the application. If such an error is encountered, please consult with your system documentation.

Internally this type is a NonZeroU32, with certain values reserved for certain purposes, see [Error::INTERNAL_START] and [Error::CUSTOM_START].

Methods

impl Error

pub const UNKNOWN: Error

Deprecated since 0.1.7

Unknown error.

pub const UNAVAILABLE: Error

Deprecated since 0.1.7

System entropy source is unavailable.

pub const INTERNAL_START: u32

Codes below this point represent OS Errors (i.e. positive i32 values). Codes at or above this point, but below [Error::CUSTOM_START] are reserved for use by the rand and getrandom crates.

pub const CUSTOM_START: u32

Codes at or above this point can be used by users to define their own custom errors.

pub fn raw_os_error(self) -> Option<i32>

Extract the raw OS error code (if this error came from the OS)

This method is identical to std::io::Error::raw_os_error(), except that it works in no_std contexts. If this method returns None, the error value can still be formatted via the Diplay implementation.

pub fn code(self) -> NonZeroU32

Extract the bare error code.

This code can either come from the underlying OS, or be a custom error. Use [Error::raw_os_error()] to disambiguate.

Trait Implementations

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl Eq for Error

impl Display for Error

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

Formats the value using the given formatter.

impl Debug for Error

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

Formats the value using the given formatter.

impl Copy for Error

impl From<NonZeroU32> for Error

fn from(code: NonZeroU32) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(err: Error) -> Self

Performs the conversion.

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Error for Error

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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