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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
use std::{convert::Infallible, error::Error as ErrorTrait, fmt};
use crate::{auth::AuthenticationClientFeedback, ffi_sdk};
pub type Result<Ok, Err = DittoError> = ::core::result::Result<Ok, Err>;
pub struct DittoError {
repr: Repr,
}
enum Repr {
Simple(ErrorKind),
Authentication(AuthenticationClientFeedback),
Ffi(FfiError),
Rust(RustError),
License(LicenseError),
}
pub enum LicenseError {
LicenseTokenVerificationFailed { message: String },
LicenseTokenExpired { message: String },
LicenseTokenUnsupportedFutureVersion { message: String },
}
impl LicenseError {
pub fn message(&self) -> &String {
match self {
LicenseError::LicenseTokenVerificationFailed { message } => message,
LicenseError::LicenseTokenExpired { message } => message,
LicenseError::LicenseTokenUnsupportedFutureVersion { message } => message,
}
}
}
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub enum ErrorKind {
Authentication,
Config,
Ffi,
Internal,
InvalidInput,
IO,
License,
NotActivated,
NonExtant,
ReleasedDittoInstance,
}
pub struct FfiError {
pub code: i32,
pub msg: String,
}
pub struct RustError {
pub kind: ErrorKind,
pub error: Box<dyn ErrorTrait + Send + Sync>,
}
impl fmt::Debug for RustError {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
let msg = format!("{:?} - {}", &self.kind, self.kind.as_str());
fmt.debug_struct("RustError")
.field("kind", &msg)
.field("error", &self.error)
.finish()
}
}
impl ErrorKind {
pub fn as_str(&self) -> &'static str {
match *self {
ErrorKind::Authentication => "Unable to authenticate Ditto",
ErrorKind::Config => "Required configuration values are missing or invalid",
ErrorKind::Ffi => "Unmapped Ditto Error",
ErrorKind::IO => "There is a problem with the underlying file, directory, or network socket",
ErrorKind::Internal => "Ditto encountered an internal error",
ErrorKind::InvalidInput => "Invalid client input provided",
ErrorKind::License => "License token error",
ErrorKind::NotActivated => "Sync could not be started because Ditto has not yet been activated. This can be achieved with a successful call to `set_license_token`. If you need to obtain a license token then please visit https://portal.ditto.live.",
ErrorKind::NonExtant => "The target entity can no longer be found",
ErrorKind::ReleasedDittoInstance => "The related Ditto instance has been closed",
}
}
}
impl From<ErrorKind> for DittoError {
fn from(kind: ErrorKind) -> DittoError {
DittoError {
repr: Repr::Simple(kind),
}
}
}
impl fmt::Debug for DittoError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.repr, f)
}
}
impl ErrorTrait for DittoError {}
impl DittoError {
pub fn new<E>(kind: ErrorKind, rust_err: E) -> DittoError
where
E: Into<Box<dyn ErrorTrait + Send + Sync>>,
{
DittoError {
repr: Repr::Rust(RustError {
kind,
error: rust_err.into(),
}),
}
}
pub fn from_str(kind: ErrorKind, msg: impl Into<String>) -> DittoError {
let msg: String = msg.into();
DittoError {
repr: Repr::Rust(RustError {
kind,
error: msg.into(),
}),
}
}
pub fn license(err: LicenseError) -> DittoError {
DittoError {
repr: Repr::License(err),
}
}
pub fn from_ffi(kind: ErrorKind) -> DittoError {
match unsafe { ffi_sdk::ditto_error_message() } {
Some(c_msg) => {
let msg = c_msg.into_string();
DittoError::new(kind, msg)
}
None => DittoError {
repr: Repr::Ffi(FfiError {
msg: "No Message".to_owned(),
code: -1,
}),
},
}
}
pub fn kind(&self) -> ErrorKind {
match &self.repr {
Repr::Simple(kind) => *kind,
Repr::Rust(e) => e.kind,
Repr::Ffi(_c) => ErrorKind::Ffi,
Repr::License(_) => ErrorKind::License,
Repr::Authentication(_) => ErrorKind::Authentication,
}
}
pub fn get_authentication_client_feedback(&self) -> Option<AuthenticationClientFeedback> {
if let Repr::Authentication(ref feedback) = self.repr {
Some(feedback.clone())
} else {
None
}
}
pub(crate) fn from_authentication_feedback(feedback: AuthenticationClientFeedback) -> Self {
DittoError {
repr: Repr::Authentication(feedback),
}
}
}
impl fmt::Debug for Repr {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
match *self {
Repr::Simple(kind) => fmt.debug_tuple("Kind").field(&kind).finish(),
Repr::Rust(ref e) => fmt::Debug::fmt(&e, fmt),
Repr::Ffi(ref c) => fmt
.debug_struct("FFIError")
.field("code", &c.code)
.field("message", &c.msg)
.field("kind", &ErrorKind::Ffi)
.finish(),
Repr::License(ref e) => fmt
.debug_struct("LicenseTokenError")
.field("message", e.message())
.field("kind", &ErrorKind::License)
.finish(),
Repr::Authentication(ref feedback) => fmt
.debug_struct("AuthenticationError")
.field("Feedback", &feedback.feedback)
.finish(),
}
}
}
impl fmt::Display for DittoError {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.repr {
Repr::Simple(kind) => write!(fmt, "{}", kind.as_str()),
Repr::Rust(ref e) => e.error.fmt(fmt),
Repr::Ffi(ref c) => write!(fmt, "{} (code {})", &c.msg, &c.code),
Repr::License(ref e) => write!(fmt, "{}", e.message()),
Repr::Authentication(ref feedback) => match feedback.feedback {
Some(ref feedback) => {
write!(fmt, "Authentication Error with feedback: {}", feedback)
}
None => {
write!(fmt, "Authentication Error")
}
},
}
}
}
error_from_i32! {
i32, ::core::num::NonZeroI32
}
#[rustfmt::skip]
macro_rules! error_from_i32 {(
$( $i32:ty ),* $(,)?
) => (
$(
impl From<$i32> for FfiError {
fn from(code: $i32) -> FfiError {
let code: i32 = code.into();
debug_assert_ne!(code, 0);
match unsafe { ffi_sdk::ditto_error_message() } {
Some(c_msg) => {
let msg = c_msg.into_string();
FfiError { code, msg }
}
None => FfiError {
msg: "No Message".to_owned(),
code,
},
}
}
}
impl From<$i32> for DittoError {
fn from(code: $i32) -> DittoError {
DittoError { repr: Repr::Ffi(code.into()) }
}
}
)*
)}
use error_from_i32;
impl From<::serde_cbor::Error> for DittoError {
fn from(err: ::serde_cbor::Error) -> Self {
DittoError::new(ErrorKind::InvalidInput, err)
}
}
impl From<::serde_json::Error> for DittoError {
fn from(err: ::serde_json::Error) -> Self {
DittoError::new(ErrorKind::InvalidInput, err)
}
}
impl From<::std::io::Error> for DittoError {
fn from(err: ::std::io::Error) -> Self {
DittoError::new(ErrorKind::IO, err)
}
}
impl From<Infallible> for DittoError {
fn from(err: Infallible) -> Self {
DittoError::new(ErrorKind::Internal, err)
}
}