cx_sdk/
error.rs

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
// Copyright 2024 Coralogix Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use http::uri::InvalidUri;
use tonic::transport::Error as TonicError;

/// The result type for the SDK.
pub type Result<T> = std::result::Result<T, SdkError>;

/// An error returned by the underlying API.
#[derive(Debug, thiserror::Error)]
pub struct SdkApiError {
    /// The status code of the error.
    pub status: tonic::Status,
    /// The endpoint that the error occurred on.
    pub endpoint: String,
    /// The feature group the endpoint belongs to.
    pub feature_group: String,
}

impl std::fmt::Display for SdkApiError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "API error on {}: {}", self.endpoint, self.status)
    }
}

/// The error type for the SDK.
#[derive(Debug, thiserror::Error)]
pub enum SdkError {
    /// This error is returned when the team that an operation refers to is not found.
    #[error("Invalid endpoint URI: {0}")]
    TeamNotFound(#[from] InvalidUri),

    /// This error is returned when an endpoint is not found.
    #[error("Endpoint not found: {0}")]
    EndpointNotFound(#[from] TonicError),

    /// This error is returned when an underying API throws an error.
    #[error("API error: {0}")]
    ApiError(#[from] SdkApiError),

    /// This error is returned when an environment variable is not found or is invalid.
    #[error("Invalid environment variable for CORALOGIX_REGION: {0}")]
    EnvConfigurationError(#[from] std::env::VarError),
}