Struct CredentialsError

pub struct CredentialsError { /* private fields */ }

Represents an error creating or using a Credentials.

The Google Cloud client libraries may experience problems creating credentials and/or using them. An example of problems creating credentials may be a badly formatted or missing key file. An example of problems using credentials may be a temporary failure to retrieve or create access tokens. Note that the latter kind of errors may happen even after the credentials files are successfully loaded and parsed.

Applications rarely need to create instances of this error type. The exception might be when testing application code, where the application is mocking a client library behavior. Such tests are extremely rare, most applications should only work with the Error type.

Example

let err = CredentialsError::from_str(
    true, "simulated retryable error while trying to create credentials");
assert!(err.is_retryable());
assert!(format!("{err}").contains("simulated retryable error"));

Implementations

impl CredentialsError

pub fn new<T>(is_retryable: bool, source: T) -> CredentialsError

where T: Error + Send + Sync + 'static,

Creates a new CredentialsError.

This function is only intended for use in the client libraries implementation. Application may use this in mocks, though we do not recommend that you write tests for specific error cases. Most tests should use the generic Error type.

Example

let err = CredentialsError::new(
    false, Error::other("simulated non-retryable error while trying to create credentials"));
assert!(!err.is_retryable());
assert!(format!("{err}").contains("simulated non-retryable error"));

Arguments

• is_retryable - A boolean indicating whether the error is retryable.
• source - The underlying error that caused the auth failure.

pub fn from_str<T>(is_retryable: bool, message: T) -> CredentialsError

where T: Into<String>,

Creates a new CredentialsError.

This function is only intended for use in the client libraries implementation. Application may use this in mocks, though we do not recommend that you write tests for specific error cases. Most tests should use the generic Error type.

Example

let err = CredentialsError::from_str(
    true, "simulated retryable error while trying to create credentials");
assert!(err.is_retryable());
assert!(format!("{err}").contains("simulated retryable error"));

Arguments

• is_retryable - A boolean indicating whether the error is retryable.
• message - The underlying error that caused the auth failure.

pub fn is_retryable(&self) -> bool

Returns true if the error is retryable; otherwise returns false.

Trait Implementations

impl Clone for CredentialsError

fn clone(&self) -> CredentialsError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialsError

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

Formats the value using the given formatter.

impl Display for CredentialsError

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

Formats the error message to include retryability and source.

impl Error for CredentialsError

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.