tenable 0.1.1

Tenable API abstraction for rust
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

use http::{header::InvalidHeaderValue, status::StatusCode};
use std::{error, fmt};

/// Possible error types occuring in this library
#[derive(Debug)]
pub enum Error<RE: fmt::Debug> {
    /// AccessKey or SecretKey contains invalid characters.
    InvalidAuth(InvalidHeaderValue),
    /// Unable to build Http Request.
    Http(http::Error),
    /// User is not allowed to perform this operation.
    InsufficientPermission,
    /// Rate Limit reached. Try again later.
    RateLimitReached,
    /// The Backoff function reached a number to high to represent while waiting
    MaximumWaitTimeReached,
    /// API returned unexpected status code.
    UnexpectedStatusCode(StatusCode),
    /// Error in inner request client.
    Request(RE),
    /// Unable to transform response to concret type.
    Deserialization(serde_json::Error),
}

impl<RE: 'static + fmt::Debug + error::Error> error::Error for Error<RE> {
    #[inline]
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            Self::InvalidAuth(err) => Some(err),
            Self::Http(err) => Some(err),
            Self::Request(err) => Some(err),
            Self::Deserialization(err) => Some(err),
            Self::InsufficientPermission
            | Self::RateLimitReached
            | Self::MaximumWaitTimeReached
            | Self::UnexpectedStatusCode(_) => None,
        }
    }
}

impl<RE: fmt::Debug> fmt::Display for Error<RE> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::InvalidAuth(_) => {
                write!(f, "AccessKey or SecretKey contains invalid characters.")
            }
            Self::Http(_) => write!(f, "Unable to build Http Request."),
            Self::InsufficientPermission => {
                write!(f, "User is not allowed to perform this operation.")
            }
            Self::RateLimitReached => write!(f, "Rate Limit reached. Try again later."),
            Self::MaximumWaitTimeReached => write!(
                f,
                "The Backoff function reached a number to high to represent while waiting."
            ),
            Self::UnexpectedStatusCode(code) => {
                write!(f, "API returned unexpected status code: {}.", code)
            }
            Self::Request(_) => write!(f, "Error in inner request client."),
            Self::Deserialization(_) => write!(f, "Unable to transform response to concret type."),
        }
    }
}

impl<RE: fmt::Debug> From<InvalidHeaderValue> for Error<RE> {
    #[inline]
    fn from(err: InvalidHeaderValue) -> Self {
        Self::InvalidAuth(err)
    }
}

impl<RE: fmt::Debug> From<http::Error> for Error<RE> {
    #[inline]
    fn from(err: http::Error) -> Self {
        Self::Http(err)
    }
}

impl<RE: fmt::Debug> From<serde_json::Error> for Error<RE> {
    #[inline]
    fn from(err: serde_json::Error) -> Self {
        Self::Deserialization(err)
    }
}