google_maps2/geocoding/
error.rs

1//! Geocoding API error types and error messages.
2
3// -----------------------------------------------------------------------------
4
5use crate::geocoding::response::status::Status;
6use miette::Diagnostic;
7use thiserror::Error;
8
9// -----------------------------------------------------------------------------
10//
11/// Errors that may be produced by the Google Maps Geocoding API client.
12
13#[derive(Debug, Diagnostic, Error)]
14#[diagnostic(code(google_maps::geocoding::error), url(docsrs))]
15pub enum Error {
16    /// Forward geocoding requests (address to latlng) must specify an `address`
17    /// or at least one `component`.
18    AddressOrComponentsRequired,
19    /// Google Maps Geocoding API server generated an error. See the `Status`
20    /// enum for more information.
21    GoogleMapsService(Status, Option<String>),
22    /// The HTTP request was unsuccessful.
23    HttpUnsuccessful(String),
24    /// API client library attempted to parse a string that contained an invalid
25    /// status code.
26    InvalidStatusCode(String),
27    /// The query string must be built before the request may be sent to the
28    /// Google Maps Geocoding API server.
29    QueryNotBuilt,
30    /// The request must be validated before a query string may be built.
31    RequestNotValidated,
32    /// The dependency library Reqwest generated an error.
33    #[cfg(feature = "enable-reqwest")]
34    Reqwest(crate::ReqError),
35    /// The dependency library Reqwest generated an error. The error could
36    /// not be passed normally so a `String` representation is passed instead.
37    #[cfg(feature = "enable-reqwest")]
38    ReqwestMessage(String),
39    /// The dependency library Serde JSON generated an error.
40    SerdeJson(serde_json::error::Error),
41} // enum
42
43impl std::fmt::Display for Error {
44    /// This trait converts the error code into a format that may be presented
45    /// to the user.
46    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
47        match self {
48            Self::AddressOrComponentsRequired => write!(f,
49                "Google Maps Geocoding API client: \
50                Forward geocoding requests must specify an `address` or at least one `component`. \
51                Ensure that the with_address() and/or with_component methods are being called before run()."),
52            Self::GoogleMapsService(status, error_message) => match error_message {
53                // If the Google Maps Geocoding API server generated an error
54                // message, return that:
55                Some(error_message) => write!(f, "Google Maps Geocoding API server: {error_message}"),
56                // If the Google Maps Geocoding API server did not generate an
57                // error message, return a generic message derived from the
58                // response status:
59                None => match status {
60                    Status::InvalidRequest => write!(f, "Google Maps Geocoding API server: \
61                        Invalid request. \
62                        This may indicate that the query (address, components, or latlng) is missing, an invalid result type, or an invalid location type."),
63                    Status::Ok => write!(f, "Google Maps Geocoding server: \
64                        Ok. \
65                        The request was successful."),
66                    Status::OverDailyLimit => write!(f, "Google Maps Geocoding API server: \
67                        Over daily limit. \
68                        Usage cap has been exceeded, API key is invalid, billing has not been enabled, or method of payment is no longer valid."),
69                    Status::OverQueryLimit => write!(f, "Google Maps Geocoding API server: \
70                        Over query limit. \
71                        Requestor has exceeded quota."),
72                    Status::RequestDenied => write!(f, "Google Maps Geocoding API server: \
73                        Request denied \
74                        Service did not complete the request."),
75                    Status::UnknownError => write!(f, "Google Maps Geocoding API server: \
76                        Unknown error."),
77                    Status::ZeroResults => write!(f, "Google Maps Geocoding API server: \
78                        Zero results. \
79                        This may occur if the geocoder was passed a non-existent address."),
80                } // match
81            }, // match
82            Self::HttpUnsuccessful(status) => write!(f,
83                "Google Maps Geocoding API client: \
84                Could not successfully query the Google Cloud Platform service. \
85                The service last responded with a `{status}` status."),
86            Self::InvalidStatusCode(status_code) => write!(f,
87                "Google Maps Geocoding API client: \
88                `{status_code}` is not a valid status code. \
89                Valid codes are `INVALID_REQUEST`, `OK`, `OVER_DAILY_LIMIT`, \
90                `OVER_QUERY_LIMIT`, `REQUEST_DENIED`, `UNKNOWN_ERROR`, and \
91                `ZERO_RESULTS`."),
92            Self::QueryNotBuilt => write!(f,
93                "Google Maps Geocoding API client: \
94                The query string must be built before the request may be sent to the Google Cloud Maps Platform. \
95                Ensure the build() method is called before run()."),
96            Self::RequestNotValidated => write!(f,
97                "Google Maps Geocoding API client: \
98                The request must be validated before a query string may be built. \
99                Ensure the validate() method is called before build()."),
100            #[cfg(feature = "enable-reqwest")]
101            Self::Reqwest(error) => write!(f, "Google Maps Geocoding API client in the Reqwest library: {error}"),
102            #[cfg(feature = "enable-reqwest")]
103            Self::ReqwestMessage(error) => write!(f, "Google Maps Geocoding API client in the Reqwest library: {error}"),
104            Self::SerdeJson(error) => write!(f, "Google Maps Geocoding API client in the Serde JSON library: {error}"),
105        } // match
106    } // fn
107} // impl
108
109// -----------------------------------------------------------------------------
110
111#[cfg(feature = "enable-reqwest")]
112impl From<reqwest::Error> for Error {
113    /// This trait converts from an Reqwest error type (`reqwest::Error`) into a
114    /// Google Maps Geocoding API error type
115    /// (`google_maps::geocoding::error::Error`) by wrapping it inside. This
116    /// function is required to use the `?` operator.
117    fn from(error: reqwest::Error) -> Self {
118        Self::Reqwest(crate::ReqError::from(error))
119    } // fn
120} // impl
121
122// -----------------------------------------------------------------------------
123
124impl From<serde_json::error::Error> for Error {
125    /// This trait converts from an Serde JSON (`serde_json::error::Error`)
126    /// error type into a Google Maps Geocoding API error type
127    /// (`google_maps::geocoding::error::Error`) by wrapping it inside. This
128    /// function is required to use the `?` operator.
129    fn from(error: serde_json::error::Error) -> Self {
130        Self::SerdeJson(error)
131    } // fn
132} // impl
google_maps2/geocoding/error.rs

google_maps2/geocoding/
error.rs
