Enum AuthError 

#[non_exhaustive]
pub enum AuthError {
    Request(RequestError),
    AccessDenied(AccessDenied),
    InvalidGrant(InvalidGrant),
    InvalidClient(InvalidClient),
    InvalidUrl(InvalidUrl),
    Region(UnsupportedRegion),
    InvalidCrn(InvalidCrn),
    WorkspaceMismatch(WorkspaceMismatch),
    InvalidWorkspaceId(InvalidWorkspaceId),
    MissingWorkspaceCrn(MissingWorkspaceCrn),
    NotAuthenticated(NotAuthenticated),
    TokenExpired(TokenExpired),
    InvalidAccessKey(InvalidAccessKeyError),
    InvalidToken(InvalidToken),
    Server(ServerError),
    AlreadyConsumed(AlreadyConsumed),
    Internal(InternalError),
    Custom(CustomError),
    Store(StoreError),
}

Errors that can occur during an authentication flow.

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.

Request(RequestError)

AccessDenied(AccessDenied)

InvalidGrant(InvalidGrant)

InvalidClient(InvalidClient)

InvalidUrl(InvalidUrl)

Region(UnsupportedRegion)

InvalidCrn(InvalidCrn)

WorkspaceMismatch(WorkspaceMismatch)

InvalidWorkspaceId(InvalidWorkspaceId)

MissingWorkspaceCrn(MissingWorkspaceCrn)

NotAuthenticated(NotAuthenticated)

TokenExpired(TokenExpired)

InvalidAccessKey(InvalidAccessKeyError)

InvalidToken(InvalidToken)

Server(ServerError)

AlreadyConsumed(AlreadyConsumed)

Internal(InternalError)

Custom(CustomError)

Store(StoreError)

Implementations

impl AuthError

pub const ERROR_CODES: &'static [&'static str]

The complete set of codes AuthError::error_code can return — the stable, machine-readable contract surfaced across FFI (JS Error.code, Node-API codes, the index.d.ts / wasm-inline.d.ts AuthFailure unions). The bindings derive their expected union from this constant rather than re-scraping the per-error AuthErrorKind::error_code impls, and auth_error_code_is_stable_for_every_variant pins that it stays in lockstep with what error_code actually returns.

pub fn error_code(&self) -> &'static str

Stable machine-readable identifier for surfacing across FFI boundaries (e.g. JS Error.code, Node-API error codes). Delegates to the wrapped error’s AuthErrorKind::error_code; every value it can return is listed in AuthError::ERROR_CODES.

pub fn from_error_code( code: &str, message: impl Into<String>, payload: &Map<String, Value>, ) -> Self

Reconstruct an AuthError from its stable FFI wire form — the type code, rendered message, and structured payload a serialized AuthError carries across the boundary (e.g. the { failure } a JS-supplied auth strategy returns; payload is the extra fields AuthErrorKind::payload emits alongside type/message).

This is the inverse an adaptor needs so that failures cross back into Rust as real AuthErrors rather than being flattened to a single opaque variant:

• the fixed-message unit codes map straight back to their variant;
• WORKSPACE_MISMATCH rebuilds from its expected/actual payload;
• every other code maps to AuthError::Custom (mirrors serde’s Error::custom), because the variants that wrap a foreign error (RequestError, InvalidUrl, UnsupportedRegion, …) have no constructor from a string, and message is the rendered Display (e.g. "Server error: …") — re-wrapping it in a prefixing variant would double the prefix.

Custom stores the message verbatim, so a reconstructed error still reads exactly as it did on the far side. error_code() round-trips exactly for the mapped codes and is CUSTOM otherwise. Pass an empty map for payload when there are no structured fields.

Trait Implementations

impl Debug for AuthError

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

Formats the value using the given formatter.

impl Diagnostic for AuthError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for AuthError

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

Formats the value using the given formatter.

impl Error for AuthError

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

fn from(source: AccessDenied) -> Self

Converts to this type from the input type.

impl From<AlreadyConsumed> for AuthError

fn from(source: AlreadyConsumed) -> Self

Converts to this type from the input type.

impl From<AuthError> for DeviceClientError

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl From<CustomError> for AuthError

fn from(source: CustomError) -> Self

Converts to this type from the input type.

impl From<DeviceClientError> for AuthError

Available on non-WebAssembly only.

fn from(e: DeviceClientError) -> Self

Converts to this type from the input type.

impl From<Error> for AuthError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Infallible> for AuthError

fn from(never: Infallible) -> Self

Converts to this type from the input type.

impl From<InternalError> for AuthError

fn from(source: InternalError) -> Self

Converts to this type from the input type.

impl From<InvalidAccessKey> for AuthError

fn from(e: InvalidAccessKey) -> Self

Converts to this type from the input type.

impl From<InvalidAccessKeyError> for AuthError

fn from(source: InvalidAccessKeyError) -> Self

Converts to this type from the input type.

impl From<InvalidClient> for AuthError

fn from(source: InvalidClient) -> Self

Converts to this type from the input type.

impl From<InvalidCrn> for AuthError

fn from(source: InvalidCrn) -> Self

Converts to this type from the input type.

impl From<InvalidCrn> for AuthError

fn from(e: InvalidCrn) -> Self

Converts to this type from the input type.

impl From<InvalidGrant> for AuthError

fn from(source: InvalidGrant) -> Self

Converts to this type from the input type.

impl From<InvalidToken> for AuthError

fn from(source: InvalidToken) -> Self

Converts to this type from the input type.

impl From<InvalidUrl> for AuthError

fn from(source: InvalidUrl) -> Self

Converts to this type from the input type.

impl From<InvalidWorkspaceId> for AuthError

fn from(source: InvalidWorkspaceId) -> Self

Converts to this type from the input type.

impl From<InvalidWorkspaceId> for AuthError

fn from(e: InvalidWorkspaceId) -> Self

Converts to this type from the input type.

impl From<MissingWorkspaceCrn> for AuthError

fn from(source: MissingWorkspaceCrn) -> Self

Converts to this type from the input type.

impl From<NotAuthenticated> for AuthError

fn from(source: NotAuthenticated) -> Self

Converts to this type from the input type.

impl From<ParseError> for AuthError

fn from(e: ParseError) -> Self

Converts to this type from the input type.

impl From<ProfileError> for AuthError

Available on non-WebAssembly only.

fn from(e: ProfileError) -> Self

Converts to this type from the input type.

impl From<RegionError> for AuthError

fn from(e: RegionError) -> Self

Converts to this type from the input type.

impl From<RequestError> for AuthError

fn from(source: RequestError) -> Self

Converts to this type from the input type.

impl From<ServerError> for AuthError

fn from(source: ServerError) -> Self

Converts to this type from the input type.

impl From<StoreError> for AuthError

fn from(source: StoreError) -> Self

Converts to this type from the input type.

impl From<TokenExpired> for AuthError

fn from(source: TokenExpired) -> Self

Converts to this type from the input type.

impl From<UnsupportedRegion> for AuthError

fn from(source: UnsupportedRegion) -> Self

Converts to this type from the input type.

impl From<WorkspaceMismatch> for AuthError

fn from(source: WorkspaceMismatch) -> Self

Converts to this type from the input type.

impl Serialize for AuthError

Serialize an AuthError into the flat, FFI-facing shape consumed by the Node and Wasm bindings: { type, message, help?, url?, ...payload }.

type/message come from the canonical code and Display; help/url are captured generically from the miette::Diagnostic surface (so per-variant help stays colocated on the struct); extra structured fields come from AuthErrorKind::payload.

serialize_map lets the wasm binding render this as a plain JS object via Serializer::serialize_maps_as_objects(true); serde_json renders a JSON object directly.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.