cp_api 0.4.0

Check Point API library
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

use std::error::Error as StdError;
use std::fmt;

/// A `Result` alias where the `Err` is `cp_api::Error`.
pub type Result<T> = std::result::Result<T, Error>;

/// The errors that can occur.
#[derive(Debug)]
pub enum Error {
    /// Reqwest errors.
    Reqwest(reqwest::Error),

    /// Occurs when setting the sid to the x-chkp-sid header name fails.
    HeaderValue(reqwest::header::InvalidHeaderValue),

    /// Occurs when converting a Reqwest HeaderMap to a HashMap fails due to non ASCII characters.
    HeaderToStr(reqwest::header::ToStrError),

    /// Serialization or deserialization errors.
    Json(serde_json::Error),

    /// I/O errors.
    Io(std::io::Error),

    /// Occurs when failing to parse an integer.
    /// Not used by cp_api, but commonly used to get port numbers in programs using this crate.
    ParseInt(std::num::ParseIntError),

    /// Occurs when parsing a Response that does not contain the expected fields.
    InvalidResponse(&'static str, serde_json::Value),

    /// Custom error message.
    Custom(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use self::Error::*;
        match self {
            Reqwest(ref e) => e.fmt(f),
            HeaderValue(ref e) => e.fmt(f),
            HeaderToStr(ref e) => e.fmt(f),
            Json(ref e) => e.fmt(f),
            Io(ref e) => e.fmt(f),
            ParseInt(ref e) => e.fmt(f),
            InvalidResponse(ref s, ref r) => {
                write!(f, "Failed to parse expected \"{}\" field from Response: {}", s, r)
            },
            Custom(ref s) => write!(f, "{}", s),
        }
    }
}

impl StdError for Error {
    fn description(&self) -> &str {
        use self::Error::*;
        match self {
            Reqwest(ref e) => e.description(),
            HeaderValue(ref e) => e.description(),
            HeaderToStr(ref e) => e.description(),
            Json(ref e) => e.description(),
            Io(ref e) => e.description(),
            ParseInt(ref e) => e.description(),
            InvalidResponse(_, _) => "Failed to parse expected field from Response",
            Custom(_) => "Custom error message",
        }
    }

    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        use self::Error::*;
        match self {
            Reqwest(_) => None,
            HeaderValue(ref e) => e.source(),
            HeaderToStr(ref e) => e.source(),
            Json(ref e) => e.source(),
            Io(ref e) => e.source(),
            ParseInt(ref e) => e.source(),
            InvalidResponse(_, _) |
            Custom(_) => None,
        }
    }
}

impl From<reqwest::Error> for Error {
    fn from(e: reqwest::Error) -> Self {
        Error::Reqwest(e)
    }
}

impl From<reqwest::header::InvalidHeaderValue> for Error {
    fn from(e: reqwest::header::InvalidHeaderValue) -> Self {
        Error::HeaderValue(e)
    }
}

impl From<reqwest::header::ToStrError> for Error {
    fn from(e: reqwest::header::ToStrError) -> Self {
        Error::HeaderToStr(e)
    }
}

impl From<serde_json::Error> for Error {
    fn from(e: serde_json::Error) -> Self {
        Error::Json(e)
    }
}

impl From<std::io::Error> for Error {
    fn from(e: std::io::Error) -> Self {
        Error::Io(e)
    }
}

impl From<std::num::ParseIntError> for Error {
    fn from(e: std::num::ParseIntError) -> Self {
        Error::ParseInt(e)
    }
}