nvisy-rt-sdk 0.1.1

Rust client for the Nvisy Runtime API: direct multimodal redaction
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

//! Structured API error returned by the runtime server.

use serde::{Deserialize, Serialize};

/// Structured error returned by the runtime API.
///
/// When the server responds with a non-success status code, the response
/// body contains a JSON object matching this structure.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ApiError {
    /// HTTP status code of the response.
    pub status: u16,
    /// Classification of the error.
    pub kind: ErrorKind,
    /// The resource involved in the error, if applicable.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub resource: Option<String>,
    /// Additional context describing what went wrong.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub context: Option<String>,
    /// Human-readable error message.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Suggested action to resolve the error.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub suggestion: Option<String>,
}

impl std::fmt::Display for ApiError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} {}", self.status, self.kind.as_str())?;
        if let Some(ref msg) = self.message {
            write!(f, ": {msg}")?;
        }
        Ok(())
    }
}

/// Classification of API errors.
///
/// Each variant corresponds to a specific HTTP status code and error scenario.
#[derive(
    Debug,
    Default,
    Clone,
    Copy,
    PartialEq,
    Eq,
    Hash,
    Serialize,
    Deserialize
)]
#[serde(rename_all = "snake_case")]
pub enum ErrorKind {
    /// 400 Bad Request: missing required path parameter.
    MissingPathParam,
    /// 400 Bad Request: invalid request data.
    BadRequest,
    /// 401 Unauthorized: missing authentication token.
    MissingAuthToken,
    /// 401 Unauthorized: malformed authentication token.
    MalformedAuthToken,
    /// 401 Unauthorized: invalid credentials.
    Unauthorized,
    /// 403 Forbidden: access denied.
    Forbidden,
    /// 404 Not Found: resource not found.
    NotFound,
    /// 409 Conflict: conflicting resource state.
    Conflict,
    /// 429 Too Many Requests: rate limit exceeded.
    TooManyRequests,
    /// 500 Internal Server Error: unexpected server error.
    #[default]
    InternalServerError,
    /// 501 Not Implemented: feature not yet implemented.
    NotImplemented,
}

impl ErrorKind {
    /// Returns the string representation of this error kind.
    pub fn as_str(&self) -> &'static str {
        match self {
            Self::MissingPathParam => "missing_path_param",
            Self::BadRequest => "bad_request",
            Self::MissingAuthToken => "missing_auth_token",
            Self::MalformedAuthToken => "malformed_auth_token",
            Self::Unauthorized => "unauthorized",
            Self::Forbidden => "forbidden",
            Self::NotFound => "not_found",
            Self::Conflict => "conflict",
            Self::TooManyRequests => "too_many_requests",
            Self::InternalServerError => "internal_server_error",
            Self::NotImplemented => "not_implemented",
        }
    }
}