Struct Error 

pub struct Error { /* private fields */ }

An error from a huskarl operation.

Carries a classification (kind), the raw OAuth error code when the server returned one (oauth_error_code), and the underlying cause (source).

Implementations

impl Error

pub fn new(kind: ErrorKind, source: impl Into<BoxedSource>) -> Self

Create an error of the given kind caused by source.

pub fn with_context(self, context: impl Into<String>) -> Self

Attach human-readable context about the failed operation (for example the endpoint being called). Shown as a prefix in the Display output.

Layers: calling this on an error that already has context prefixes the existing context, so outer operations read first ("fetching client secret: reading secret file /run/secret: ...").

pub fn with_oauth_error_code(self, code: impl Into<String>) -> Self

Attach the raw OAuth error code returned by the server (see oauth_error_code for the codes this covers).

pub fn kind(&self) -> ErrorKind

The classification of this error.

pub fn oauth_error_code(&self) -> Option<&str>

The raw error code from the server’s OAuth error response, if it returned one.

Most commonly an RFC 6749 §5.2 token-endpoint error code (e.g. invalid_grant, invalid_scope), but the same field carries the equivalent code from any OAuth error response, including extension responses that reuse the error member — for example use_dpop_nonce (RFC 9449) or a dynamic client registration error (RFC 7591 §3.2.2, such as invalid_redirect_uri). It is the verbatim string from the server; match on it only against codes defined by the protocol that produced the error.

pub fn is_retryable(&self) -> bool

If true, the failure is transient and the same call may succeed if re-attempted (with backoff). No user involvement is needed; in particular this is not a reason to re-run the interactive flow.

See the error model for how this composes with ErrorKind::ReauthRequired.

pub fn is_dpop_nonce_required(&self) -> bool

If true, the server requires a DPoP nonce (RFC 9449 §8) — the error carries the use_dpop_nonce OAuth error code.

The nonce value itself has already been recorded from the DPoP-Nonce response header by the time this error propagates; retry the request with freshly generated authentication parameters.

Trait Implementations

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 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 From<Error> for DecryptError

where Error: Into<Error>,

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for VerifyError

where Error: Into<Error>,

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CreateVerifierError

where Error: Into<Error>,

fn from(error: Error) -> Self

Converts to this type from the input type.

impl From<ErrorKind> for Error

fn from(kind: ErrorKind) -> Self

Converts to this type from the input type.