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.

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 IOS_SEC_RANDOM: Error

Call to iOS SecRandomCopyBytes failed.

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 browser does not have support for self.crypto.

pub const WEB_GET_RANDOM_VALUES: Error

The browser does not have support for crypto.getRandomValues.

pub const VXWORKS_RAND_SECURE: Error

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

pub const NODE_CRYPTO: Error

NodeJS does not have support for the crypto module.

pub const NODE_RANDOM_FILL_SYNC: Error

NodeJS does not have support for crypto.randomFillSync.

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

pub fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Error

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

This is supported on crate feature std only.

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<NonZeroU32> for Error

pub fn from(code: NonZeroU32) -> Self

Performs the conversion.

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl StructuralEq for Error

impl StructuralPartialEq for Error