Struct Error

pub struct Error(/* private fields */);

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.

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

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

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.

pub const IOS_SEC_RANDOM: Error

Call to CCRandomGenerateBytes failed on iOS, tvOS, or waatchOS.

pub const WINDOWS_RTL_GEN_RANDOM: Error

Call to Windows RtlGenRandom failed.

pub const FAILED_RDRAND: Error

RDRAND instruction failed due to a hardware issue.

pub const NO_RDRAND: Error

RDRAND instruction unsupported on this target.

pub const WEB_CRYPTO: Error

The environment does not support the Web Crypto API.

pub const WEB_GET_RANDOM_VALUES: Error

Calling Web Crypto API crypto.getRandomValues failed.

pub const VXWORKS_RAND_SECURE: Error

On VxWorks, call to randSecure failed (random number generator is not yet initialized).

pub const NODE_CRYPTO: Error

Node.js does not have the crypto CommonJS module.

pub const NODE_RANDOM_FILL_SYNC: Error

Calling Node.js function crypto.randomFillSync failed.

pub const NODE_ES_MODULE: Error

Called from an ES module on Node.js. This is unsupported, see: https://docs.rs/getrandom#nodejs-es-module-support.

pub const INTERNAL_START: u32 = 2_147_483_648u32

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 = 3_221_225_472u32

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 Display implementation.

pub const 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 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 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 From<NonZero<u32>> for Error

fn from(code: NonZeroU32) -> 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