taskfast-client 0.12.2

Typed HTTP client for the TaskFast marketplace API (generated from spec/openapi.yaml).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

// SPDX-License-Identifier: MIT
//! Cross-cutting error type for the typed client.
//!
//! Variants mirror the orchestrator-centric exit-code buckets used by
//! `taskfast-cli` (see `map_api_error` in [`crate::client`]): callers branch
//! on `Auth` to re-credential, `Validation` to surface payload/state issues,
//! `RateLimited` to back off, `Server`/`Network` to retry, `Decode` to bail.

use std::time::Duration;

use thiserror::Error;

/// Convenience alias for `Result<T, [Error]>` returned by client APIs.
pub type Result<T> = std::result::Result<T, Error>;

/// Unified error surface for typed-client operations.
#[derive(Debug, Error)]
pub enum Error {
    /// Authentication or authorization failure (HTTP 401/403, bad header bytes,
    /// etc.). Caller should re-credential, not retry the same payload.
    #[error("auth: {0}")]
    Auth(String),

    /// Server rejected the request payload or current state (HTTP 4xx other
    /// than 401/403/429). `code` is the TaskFast `error` envelope tag (e.g.
    /// `"validation_error"`); `message` is the human-readable detail.
    #[error("validation ({code}): {message}")]
    Validation {
        /// TaskFast `components/schemas/Error.error` short code.
        code: String,
        /// Human-readable detail from the API response body.
        message: String,
    },

    /// Server responded 429 Too Many Requests. `retry_after` reflects the
    /// `Retry-After` header (or a 1-second default when absent/unparseable).
    #[error("rate limited (retry in {retry_after:?})")]
    RateLimited {
        /// Duration callers should sleep before re-issuing the request.
        retry_after: Duration,
    },

    /// Server-side failure (HTTP 5xx) or pre-flight client-side error that
    /// callers should treat as transient + retry-eligible.
    #[error("server: {0}")]
    Server(String),

    /// Underlying transport (DNS, connect, TLS, body stream) failed.
    #[error("network: {0}")]
    Network(#[from] reqwest::Error),

    /// Response body could not be deserialised into the expected schema.
    #[error("decode: {0}")]
    Decode(#[from] serde_json::Error),
}

impl Error {
    /// Short, stable variant tag for logging without leaking the inner
    /// message. A compromised server (or an endpoint that echoes request
    /// bodies into its error strings) could land an `X-API-Key` value
    /// inside an `Auth`/`Server` payload — logging the full `Display`
    /// would then page the secret into any log sink. Callers that need
    /// logging should prefer [`Self::kind`] over `?err`.
    pub fn kind(&self) -> &'static str {
        match self {
            Self::Auth(_) => "auth",
            Self::Validation { .. } => "validation",
            Self::RateLimited { .. } => "rate_limited",
            Self::Server(_) => "server",
            Self::Network(_) => "network",
            Self::Decode(_) => "decode",
        }
    }
}