treetop-client 0.1.0

Typed async Rust client for Treetop policy authorization servers
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
75
76

//! Error types for the Treetop client.

use reqwest::StatusCode;
use thiserror::Error;

use crate::types::ValidationError;

/// Errors that can occur when using the Treetop client.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum TreetopError {
    /// A network or connection-level error from the HTTP transport.
    #[error("HTTP transport error: {0}")]
    Transport(#[from] reqwest::Error),

    /// The server returned a non-success HTTP status with an error message.
    ///
    /// The `status` field contains the HTTP status code (e.g. 400, 403, 500),
    /// and `message` contains the server's error description.
    #[error("API error (HTTP {status}): {message}")]
    Api {
        /// HTTP status returned by the server.
        status: StatusCode,
        /// Server-provided error description, with configured credentials redacted.
        message: String,
    },

    /// Failed to deserialize the response body from the server.
    #[error("Response deserialization error: {0}")]
    Deserialization(#[from] serde_json::Error),

    /// Failed to serialize a request body before transport.
    #[error("Request serialization error: {0}")]
    Serialization(#[source] serde_json::Error),

    /// A request value violates a local Treetop or Cedar invariant.
    #[error("Request validation error: {0}")]
    Validation(#[from] ValidationError),

    /// The provided URL could not be parsed.
    #[error("Invalid URL: {0}")]
    InvalidUrl(#[from] url::ParseError),

    /// A client configuration error, such as an invalid URL, header, limit, or TLS setup.
    #[error("Client configuration error: {0}")]
    Configuration(String),

    /// A successful response body exceeded the configured safety limit.
    #[error("Response body exceeds the configured limit of {limit} bytes")]
    ResponseTooLarge {
        /// Configured maximum number of response-body bytes.
        limit: usize,
    },

    /// A request body exceeded the configured safety limit before transport.
    #[error("Request body exceeds the configured limit of {limit} bytes")]
    RequestTooLarge {
        /// Configured maximum number of request-body bytes.
        limit: usize,
    },

    /// A successful plain-text response was not valid UTF-8.
    #[error("Successful text response is not valid UTF-8")]
    InvalidTextResponse,

    /// The server returned a structurally inconsistent successful response.
    #[error("Invalid API response: {0}")]
    InvalidResponse(String),

    /// A request in an authorization batch failed evaluation.
    #[error("Authorization evaluation failed: {0}")]
    Evaluation(String),
}

/// A `Result` type alias using [`TreetopError`].
pub type Result<T> = std::result::Result<T, TreetopError>;