Struct Error

pub struct Error(NonZeroI32);

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.

If this crate’s "std" Cargo feature is enabled, then:

• getrandom::Error implements std::error::Error
• std::io::Error implements From<getrandom::Error>.

Tuple Fields

0: NonZeroI32

Implementations

impl Error

pub const UNSUPPORTED: Error

This target/platform is not supported by getrandom.

pub const ERRNO_NOT_POSITIVE: Error

The platform-specific errno returned a non-positive value.

pub const UNEXPECTED: Error

Encountered an unexpected situation which should not happen in practice.

const INTERNAL_START: i32 = 65_536i32

Internal errors can be in the range of 2^16..2^17

const CUSTOM_START: i32 = 131_072i32

Custom errors can be in the range of 2^17..(2^17 + 2^16)

pub(crate) fn from_neg_error_code(code: i32) -> Self

Creates a new instance of an Error from a negative error code.

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. On most targets this method returns Option<i32>, but some platforms (e.g. UEFI) may use a different primitive type like usize. Consult with the RawOsError docs for more information.

If this method returns None, the error value can still be formatted via the Display implementation.

pub const fn new_custom(n: u16) -> Error

Creates a new instance of an Error from a particular custom error code.

pub(crate) const fn new_internal(n: u16) -> Error

Creates a new instance of an Error from a particular internal error code.

fn internal_desc(&self) -> Option<&'static str>

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

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(err: Error) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Error

impl Eq for Error

impl StructuralPartialEq for Error