ploidy-util 0.15.0

Runtime support for crates generated by Ploidy
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::fmt::{Display, Formatter, Result as FmtResult};

use http::{HeaderName, StatusCode};
use url::ParseError as UrlParseError;

use crate::{query::QueryParamError, url::PathAndQueryError};

/// A client error.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error("error building request")]
    Build(#[from] BuildError),

    #[error("HTTP transport error")]
    Transport(#[source] reqwest::Error),

    #[error("HTTP status error ({0})")]
    Status(StatusCode),

    #[error("invalid or unexpected response body")]
    Body(#[from] BodyError),
}

impl Error {
    /// Creates an error for an invalid HTTP header name.
    #[cold]
    pub fn bad_header_name(err: impl Into<http::Error>) -> Self {
        Self::Build(BuildError::HeaderName(err.into()))
    }

    /// Creates an error for an invalid HTTP header value.
    #[cold]
    pub fn bad_header_value(name: HeaderName, err: impl Into<http::Error>) -> Self {
        Self::Build(BuildError::HeaderValue(name, err.into()))
    }

    /// Returns the telemetry category for this error.
    pub fn category(&self) -> ErrorCategory {
        match self {
            Self::Build(_) => ErrorCategory::Build,
            Self::Transport(err) if err.is_timeout() => ErrorCategory::Timeout,
            Self::Transport(err) if err.is_connect() => ErrorCategory::Connect,
            Self::Transport(_) => ErrorCategory::Transport,
            &Self::Status(status) => ErrorCategory::Status(status),
            Self::Body(_) => ErrorCategory::Body,
        }
    }
}

impl From<QueryParamError> for Error {
    fn from(err: QueryParamError) -> Self {
        Self::Build(BuildError::QueryParam(err))
    }
}

impl From<PathAndQueryError> for Error {
    fn from(err: PathAndQueryError) -> Self {
        Self::Build(BuildError::Path(err))
    }
}

impl From<UrlParseError> for Error {
    fn from(err: UrlParseError) -> Self {
        Self::Build(BuildError::Url(err))
    }
}

impl From<reqwest::Error> for Error {
    #[cold]
    fn from(err: reqwest::Error) -> Self {
        if err.is_builder() {
            Self::Build(BuildError::Request(err))
        } else if let Some(status) = err.status() {
            Self::Status(status)
        } else {
            Self::Transport(err)
        }
    }
}

impl From<serde_json::Error> for Error {
    #[cold]
    fn from(err: serde_json::Error) -> Self {
        Self::Body(BodyError::Json(err))
    }
}

impl From<serde_path_to_error::Error<serde_json::Error>> for Error {
    #[cold]
    fn from(err: serde_path_to_error::Error<serde_json::Error>) -> Self {
        Self::Body(BodyError::JsonWithPath(err))
    }
}

#[derive(Debug, thiserror::Error)]
pub enum BuildError {
    #[error("invalid URL")]
    Url(#[source] UrlParseError),
    #[error("invalid query parameter")]
    QueryParam(#[source] QueryParamError),
    #[error(transparent)]
    Path(PathAndQueryError),
    #[error("invalid header name")]
    HeaderName(#[source] http::Error),
    #[error("invalid value for header `{0}`")]
    HeaderValue(HeaderName, #[source] http::Error),
    #[error(transparent)]
    Request(reqwest::Error),
}

/// Invalid or unexpected response body, with or without a path
/// to the unexpected section.
#[derive(Debug, thiserror::Error)]
pub enum BodyError {
    #[error(transparent)]
    Json(serde_json::Error),
    #[error(transparent)]
    JsonWithPath(serde_path_to_error::Error<serde_json::Error>),
}

/// The telemetry category for an [`Error`].
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum ErrorCategory {
    Build,
    Connect,
    Timeout,
    Transport,
    Status(StatusCode),
    Body,
}

impl Display for ErrorCategory {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        f.write_str(match self {
            Self::Build => "build",
            Self::Connect => "connect",
            Self::Timeout => "timeout",
            Self::Transport => "transport",
            Self::Status(status) => status.as_str(),
            Self::Body => "body",
        })
    }
}