Struct signature::Error

pub struct Error { /* private fields */ }

Signature errors.

This type is deliberately opaque as to avoid sidechannel leakage which could potentially be used recover signing private keys or forge signatures (e.g. BB’06).

When the std feature is enabled, it impls std::error::Error and supports an optional std::error::Error::source, which can be used by things like remote signers (e.g. HSM, KMS) to report I/O or auth errors.

Implementations

impl Error

pub fn new() -> Self

Create a new error with no associated source

pub fn from_source(
    source: impl Into<Box<dyn Error + Send + Sync + 'static>>
) -> Self

Create a new error with an associated source.

NOTE: The “source” 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.

Trait Implementations

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

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

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

impl From<Box<dyn Error + Send + Sync + 'static, Global>> for Error

fn from(source: Box<dyn Error + Send + Sync + 'static>) -> Error

Performs the conversion.