Struct Error 

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

The single, opaque failure a verifier returns. Its Display is uniform across every cause (the uniform-failure rule of the Security Considerations, §16.6); the granular Reason is available via Error::reason for internal logging only.

use obsigil::{Issuer, MandateKey, NoApp, Reason, Verifier};
let token = Issuer::new(MandateKey::from_bytes([42u8; 64])?)
    .clauses(&NoApp::default())
    .exp(1_000)
    .mint()?;
let key = MandateKey::from_bytes([42u8; 64])?;
let err = Verifier::new().key(&key).now(2_000)
    .clauses::<NoApp>(&token)
    .unwrap_err();
// The bearer sees one uniform message...
assert_eq!(err.to_string(), "obsigil: token rejected");
// ...while the server can log the precise internal cause.
assert!(matches!(err.reason(), Reason::Expired));

Implementations

impl Error

pub fn reason(&self) -> Reason

The internal cause, for server-side logging/telemetry only. Do not surface this to the bearer (the uniform-failure rule of the Security Considerations, §16.6).

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Error

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

impl Error for Error

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

Returns the lower-level source of this error, if any.

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

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

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