Enum Error 

pub enum Error {
    Transport(Error),
    Grpc(Box<Status>),
    Auth(String),
    InvalidUri(String),
    InvalidMetadata(InvalidMetadataValue),
}

All errors that can be returned by the Armada client.

Most callers can pattern-match on the variant that matters to them and propagate the rest with ?. Use Error::auth as a convenience constructor when implementing crate::auth::TokenProvider.

Example

use armada_client::{ArmadaClient, Error, StaticTokenProvider};

async fn submit_or_retry(client: &ArmadaClient) {
    // ... build request ...
    match client.submit(request).await {
        Ok(resp) => { /* handle success */ }
        Err(Error::Grpc(status)) => {
            // The server returned a non-OK gRPC status (e.g. NOT_FOUND).
            eprintln!("gRPC error: {status}");
        }
        Err(Error::Auth(msg)) => {
            // Token provider failed — check credentials.
            eprintln!("auth failure: {msg}");
        }
        Err(e) => eprintln!("other error: {e}"),
    }
}

Variants

Transport(Error)

A low-level transport failure occurred before a gRPC response could be received — for example a connection refused, TLS handshake error, or DNS resolution failure.

Grpc(Box<Status>)

The server returned a non-OK gRPC status code.

Common codes:

• NOT_FOUND — the requested queue or job set does not exist.
• PERMISSION_DENIED — the bearer token lacks the required privileges.
• INVALID_ARGUMENT — the request payload was rejected by the server.

Auth(String)

Returned by custom crate::auth::TokenProvider implementations to signal that token retrieval failed.

InvalidUri(String)

Returned when the endpoint string passed to crate::client::ArmadaClient::connect or crate::client::ArmadaClient::connect_tls is not a valid URI.

InvalidMetadata(InvalidMetadataValue)

The bearer token string contained characters that are not valid in an HTTP header value. Token strings must be ASCII and must not contain control characters (\0, \r, \n, etc.).

Implementations

impl Error

pub fn auth(msg: impl Into<String>) -> Self

Convenience constructor for Error::Auth.

Use this in custom crate::auth::TokenProvider implementations:

return Err(Error::auth("token expired"));

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidMetadataValue> for Error

fn from(source: InvalidMetadataValue) -> Self

Converts to this type from the input type.

impl From<Status> for Error

fn from(s: Status) -> Self

Converts to this type from the input type.