Enum AuthplaneError 

#[non_exhaustive]
pub enum AuthplaneError {
    Auth(AuthError),
    ConsentRequired(Box<ConsentRequiredError>),
    CircuitOpen,
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auth(AuthError)

ConsentRequired(Box<ConsentRequiredError>)

The payload is boxed. ConsentRequiredError carries six fields (128 bytes) against AuthError’s three (56), so leaving it inline makes every Result<_, AuthplaneError> in the crate — overwhelmingly the success path — as wide as the rarest error. Boxing keeps the enum at 64 bytes.

Construct with AuthplaneError::from(consent) or consent.into(); match arms bind a Box<ConsentRequiredError> and reach the fields through Deref, so patterns need no change.

CircuitOpen

Circuit breaker is open — the authorization server is considered unavailable.

Implementations

impl AuthplaneError

Convenience predicates on AuthplaneError for common error categories.

pub fn is_circuit_open(&self) -> bool

pub fn is_consent_required(&self) -> bool

Trait Implementations

impl Clone for AuthplaneError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthplaneError

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

Formats the value using the given formatter.

impl Display for AuthplaneError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for AuthplaneError

impl Error for AuthplaneError

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<AuthError> for AuthplaneError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<Box<ConsentRequiredError>> for AuthplaneError

fn from(source: Box<ConsentRequiredError>) -> Self

Converts to this type from the input type.

impl From<ConsentRequiredError> for AuthplaneError

Boxing companion for the derived From<Box<ConsentRequiredError>>, so call sites and ? keep converting an unboxed ConsentRequiredError.

fn from(error: ConsentRequiredError) -> Self

Converts to this type from the input type.

impl PartialEq for AuthplaneError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for AuthplaneError