Enum TokenSourceError 

pub enum TokenSourceError {
    Unavailable(Arc<dyn Error + Sync + Send>),
    Rejected(Arc<dyn Error + Sync + Send>),
    Broken(Arc<dyn Error + Sync + Send>),
}

Why a token source could not provide a token.

A source knows what it authenticates against, so it is the only place that can tell whether asking again may work. The variant it picks is how it says so; callers read it back through TokenSourceError::is_transient instead of interpreting the cause themselves.

Variants

Unavailable(Arc<dyn Error + Sync + Send>)

No token right now, but a later call may produce one, e.g. because the request to the token service did not get through.

Rejected(Arc<dyn Error + Sync + Send>)

The credential the source authenticates with was refused, or the answer it got back cannot be used as a token. Asking again yields the same answer.

Broken(Arc<dyn Error + Sync + Send>)

The source itself stopped working, e.g. the task that refreshes its token is gone, so it will not produce a token again.

Implementations

impl TokenSourceError

pub fn unavailable( cause: impl Into<Box<dyn Error + Sync + Send>>, ) -> TokenSourceError

The token could not be obtained now, but a later call may succeed.

pub fn rejected( cause: impl Into<Box<dyn Error + Sync + Send>>, ) -> TokenSourceError

The token cannot be obtained, no matter how often it is asked for.

pub fn broken( cause: impl Into<Box<dyn Error + Sync + Send>>, ) -> TokenSourceError

The source can no longer hand out tokens at all.

pub fn is_transient(&self) -> bool

Returns whether the failure is transient, so that a retry may help.

Prefer this over matching the variants: a new variant would silently fall into a caller’s wildcard arm.

Trait Implementations

impl Clone for TokenSourceError

fn clone(&self) -> TokenSourceError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenSourceError

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

Formats the value using the given formatter.

impl Display for TokenSourceError

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

Formats the value using the given formatter.

impl Error for TokenSourceError

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<TokenSourceError> for CrpcClientError

fn from(source: TokenSourceError) -> CrpcClientError

Converts to this type from the input type.