hackmd-api-client-rs 0.3.0

🦀📝 A HackMD Rust API client for rustacean & friends
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use reqwest::header;
use std::{error, fmt, result};

#[derive(Debug)]
pub struct HackMDError {
    pub message: String,
}

impl fmt::Display for HackMDError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl error::Error for HackMDError {}

#[derive(Debug)]
pub struct HttpResponseError {
    pub message: String,
    pub code: u16,
    pub status_text: String,
}

impl fmt::Display for HttpResponseError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} ({})", self.message, self.code)
    }
}

impl error::Error for HttpResponseError {}

#[derive(Debug)]
pub struct MissingRequiredArgument {
    pub message: String,
}

impl fmt::Display for MissingRequiredArgument {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.message)
    }
}

impl error::Error for MissingRequiredArgument {}

#[derive(Debug)]
pub struct InternalServerError {
    pub message: String,
    pub code: u16,
    pub status_text: String,
}

impl fmt::Display for InternalServerError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} ({})", self.message, self.code)
    }
}

impl error::Error for InternalServerError {}

#[derive(Debug)]
pub struct TooManyRequestsError {
    pub message: String,
    pub code: u16,
    pub status_text: String,
    pub user_limit: u32,
    pub user_remaining: u32,
    pub reset_after: Option<u64>,
}

impl fmt::Display for TooManyRequestsError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{} ({}): {}/{} requests remaining",
            self.message, self.code, self.user_remaining, self.user_limit
        )
    }
}

impl error::Error for TooManyRequestsError {}

#[derive(Debug)]
pub enum ApiError {
    HackMD(HackMDError),
    HttpResponse(HttpResponseError),
    MissingRequiredArgument(MissingRequiredArgument),
    InternalServer(InternalServerError),
    TooManyRequests(TooManyRequestsError),
    Reqwest(reqwest::Error),
    Url(url::ParseError),
    Header(header::InvalidHeaderValue),
    Serde(serde_json::Error),
}

impl fmt::Display for ApiError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ApiError::HackMD(err) => write!(f, "HackMD error: {}", err),
            ApiError::HttpResponse(err) => write!(f, "HTTP response error: {}", err),
            ApiError::MissingRequiredArgument(err) => {
                write!(f, "Missing required argument: {}", err)
            }
            ApiError::InternalServer(err) => write!(f, "Internal server error: {}", err),
            ApiError::TooManyRequests(err) => write!(f, "Too many requests: {}", err),
            ApiError::Reqwest(err) => write!(f, "Request error: {}", err),
            ApiError::Url(err) => write!(f, "URL parse error: {}", err),
            ApiError::Header(err) => write!(f, "Header error: {}", err),
            ApiError::Serde(err) => write!(f, "Serialization error: {}", err),
        }
    }
}

impl error::Error for ApiError {}

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

impl From<url::ParseError> for ApiError {
    fn from(error: url::ParseError) -> Self {
        ApiError::Url(error)
    }
}

impl From<header::InvalidHeaderValue> for ApiError {
    fn from(error: header::InvalidHeaderValue) -> Self {
        ApiError::Header(error)
    }
}

impl From<serde_json::Error> for ApiError {
    fn from(error: serde_json::Error) -> Self {
        ApiError::Serde(error)
    }
}

pub type Result<T> = result::Result<T, ApiError>;