Enum ApiError 

pub enum ApiError {
    Status {
        request: String,
        status: u16,
        message: String,
        retry_after: Option<Duration>,
    },
    Transport {
        request: String,
        source: Error,
    },
    Timeout {
        request: String,
        budget: Duration,
    },
    TooLarge {
        request: String,
        cap: usize,
    },
    Malformed {
        request: String,
        source: Error,
    },
    Token(String),
    JwtFile {
        path: PathBuf,
        source: Error,
    },
    Config(String),
}

A call that did not produce the answer it was asked for.

Variants

Status

The control plane answered, and the answer was not a success.

Fields

request: String

The method and path, for saying which call this was.

status: u16

message: String

The API’s own message field where it sent one, the body where it did not, and the status’s reason where the body was empty.

retry_after: Option<Duration>

What the server asked us to wait, from Retry-After.

Transport

The request never became a response: no route, refused, TLS, a reset.

Fields

request: String

source: Error

Timeout

The call used up the budget it was given, across every attempt.

Fields

request: String

budget: Duration

TooLarge

The body is larger than this server will hold in memory.

Fields

request: String

cap: usize

Malformed

The body arrived and is not what it should be.

Fields

request: String

source: Error

Token(String)

A token could not be minted, so no call can be made at all.

JwtFile

The federated identity’s JWT could not be read from disk.

Fields

path: PathBuf

source: Error

Config(String)

The client was built wrong. Never depends on the network, so it is worth telling apart from everything above.

Implementations

impl ApiError

pub const fn status(&self) -> Option<u16>

The status the control plane sent, where there was one.

The server crate turns this into the tool error’s status field, which is the number a caller needs to look the failure up in Tailscale’s own documentation.

pub const fn is_transient(&self) -> bool

Whether asking again could plausibly work.

This is about the failure, not about the request: whether this call may be sent twice is Idempotence, and both have to agree before anything is retried.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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.