Enum AuthError 

#[non_exhaustive]
pub enum AuthError {
    MissingField(&'static str),
    OAuth {
        error: String,
        error_description: Option<String>,
    },
    Other(String),
    Http(Error),
    Serialization(Error),
    Url(ParseError),
}

Errors produced while acquiring or refreshing a Salesforce OAuth session.

The error_description carried by AuthError::OAuth is server-supplied free text that can include partial token material, so it is redacted from both the Display and Debug representations of this type — only the machine-readable error code is shown. Callers that need the description can read it from the variant field directly.

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.

MissingField(&'static str)

A required builder field was not set.

OAuth

OAuth token endpoint returned an error response (error / error_description shape from RFC 6749 §5.2).

Only the machine-readable error code is surfaced via Display; error_description is redacted (see the type-level note) but remains available by matching on the field.

Fields

error: String

error_description: Option<String>

Other(String)

Catch-all for auth failures not modelled by a dedicated variant (system clock skew, JWT signing failure, CSPRNG failure, malformed token responses, etc.). Carries the underlying message.

Http(Error)

Network or transport-level HTTP failure while contacting an OAuth endpoint.

Serialization(Error)

JSON serialization or deserialization failure.

Url(ParseError)

URL parsing failure (instance URL, redirect URI, login URL, etc.).

Trait Implementations

impl Debug for AuthError

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

Formats the value using the given formatter.

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for AuthError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for AuthError

fn from(source: ParseError) -> Self

Converts to this type from the input type.