Struct signature::Error

pub struct Error { /* fields omitted */ }

Signature errors

Methods

impl Error

pub fn new() -> Self

Create a new error with no cause

pub fn from_cause<E>(cause: E) -> Self where
    E: Into<Box<dyn Error>>, 

Create a new error with an associated cause.

NOTE: The "cause" should NOT be used to propagate cryptographic errors e.g. signature parsing or verification errors.

The intended use cases are for propagating errors related to external signers, e.g. communication/authentication errors with HSMs, KMS, etc.

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

Borrow the error's underlying cause (if available)

pub fn into_cause(self) -> Box<dyn Error>

Extract the underlying cause of this error.

Panics if the error does not have a cause.

pub fn downcast<T>(self) -> Result<Box<T>, Box<dyn Error>> where
    T: Error + 'static, 

Attempt to downcast this error's cause into a concrete type

pub fn downcast_ref<T>(&self) -> Option<&T> where
    T: Error + 'static, 

Attempt to downcast a reference to this error's cause into a concrete type

Trait Implementations

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 Default for Error

fn default() -> Error

Returns the "default value" for a type.

impl Error for Error

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 description(&self) -> &str

This method is soft-deprecated.

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.