Struct rand_core::Error

pub struct Error {
    pub kind: ErrorKind,
    pub msg: &'static str,
    // some fields omitted
}

Error type of random number generators

This is a relatively simple error type, designed for compatibility with and without the Rust std library. It embeds a "kind" code, a message (static string only), and an optional chained cause (std only). The kind and msg fields can be accessed directly; cause can be accessed via std::error::Error::cause or Error::take_cause. Construction can only be done via Error::new or Error::with_cause.

Fields

kind: ErrorKind

The error kind

msg: &'static str

The error message

Methods

impl Error

pub fn new(kind: ErrorKind, msg: &'static str) -> Error

Create a new instance, with specified kind and a message.

pub fn with_cause<E>(kind: ErrorKind, msg: &'static str, cause: E) -> Error where
    E: Into<Box<dyn Error + 'static + Send + Sync>>, 

Create a new instance, with specified kind, message, and a chained cause.

Note: stdError is an alias for std::error::Error.

If not targetting std (i.e. no_std), this function is replaced by another with the same prototype, except that there are no bounds on the type E (because both Box and stdError are unavailable), and the cause is ignored.

pub fn take_cause(&mut self) -> Option<Box<dyn Error + 'static + Send + Sync>>

Take the cause, if any. This allows the embedded cause to be extracted. This uses Option::take, leaving self with no cause.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

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.

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

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

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