aria2-rs 0.3.0

Yet Another Aria2 JSON-RPC Client.
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
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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use std::borrow::Cow;

use serde::{de::DeserializeOwned, ser::SerializeSeq as _, Deserialize, Serializer};
use serde_json::Value;

use crate::{options::TaskOptions, SmallString, SmallVec};

type SerializeSeq = <serde_json::value::Serializer as serde::ser::Serializer>::SerializeSeq;
type JsonError = serde_json::Error;

macro_rules! option {
    ($opt: expr, $serializer: expr) => {
        if let Some(value) = $opt {
            $serializer.serialize_element(value)?;
        }
    };
}
macro_rules! empty {
    ($map: expr, $serializer: expr) => {
        if !$map.is_empty() {
            $serializer.serialize_element($map)?;
        }
    };
}

pub trait Reply {
    type Reply: DeserializeOwned;
    #[inline]
    fn to_reply(value: Value) -> crate::Result<Self::Reply> {
        serde_json::from_value::<Self::Reply>(value).map_err(crate::Error::Decode)
    }
}

pub trait Call {
    // Why not define as a const: to make it object safe.
    fn method(&self) -> &'static str;
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError>;

    fn to_param(&self, token: Option<&str>) -> std::result::Result<Value, serde_json::Error> {
        let mut serializer = serde_json::value::Serializer.serialize_seq(None)?;
        self.serialize_params(&mut serializer, token)?;
        serializer.end()
    }
}

pub struct AddUriCall {
    pub uris: SmallVec<String>,
    pub options: Option<TaskOptions>,
}

impl Reply for AddUriCall {
    type Reply = GidReply;
}

#[derive(Deserialize, Debug, Clone)]
#[serde(transparent)]
pub struct GidReply(pub SmallString);

impl Call for AddUriCall {
    fn method(&self) -> &'static str {
        "aria2.addUri"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.uris)?;
        option!(&self.options, serializer);
        Ok(())
    }
}

pub struct AddTorrentCall<'a> {
    pub torrent: Cow<'a, [u8]>,
    pub uris: SmallVec<Cow<'a, str>>,
    pub options: Option<TaskOptions>,
}

impl Reply for AddTorrentCall<'_> {
    type Reply = GidReply;
}

impl Call for AddTorrentCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.addTorrent"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        use base64::{engine::general_purpose, Engine as _};
        let encoded: String = general_purpose::STANDARD.encode(&self.torrent);

        option!(token, serializer);
        serializer.serialize_element(&encoded)?;
        serializer.serialize_element(&self.uris)?;
        option!(&self.options, serializer);
        Ok(())
    }
}

pub struct AddMetalinkCall<'a> {
    pub metalink: Cow<'a, str>,
    pub options: Option<TaskOptions>,
}

impl Reply for AddMetalinkCall<'_> {
    type Reply = Vec<GidReply>;
}

impl Call for AddMetalinkCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.addMetalink"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.metalink)?;
        option!(&self.options, serializer);
        Ok(())
    }
}

pub struct RemoveCall<'a> {
    pub gid: Cow<'a, str>,
}

impl Reply for RemoveCall<'_> {
    type Reply = GidReply;
}

impl Call for RemoveCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.remove"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        Ok(())
    }
}

pub struct ForceRemoveCall<'a> {
    pub gid: Cow<'a, str>,
}

impl Reply for ForceRemoveCall<'_> {
    type Reply = GidReply;
}

impl Call for ForceRemoveCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.forceRemove"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        Ok(())
    }
}

pub struct PauseCall<'a> {
    pub gid: Cow<'a, str>,
}

impl Reply for PauseCall<'_> {
    type Reply = GidReply;
}

impl Call for PauseCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.pause"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        Ok(())
    }
}

pub struct ForcePauseCall<'a> {
    pub gid: Cow<'a, str>,
}

impl Reply for ForcePauseCall<'_> {
    type Reply = GidReply;
}

impl Call for ForcePauseCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.forcePause"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        Ok(())
    }
}

pub struct UnpauseCall<'a> {
    pub gid: Cow<'a, str>,
}

impl Reply for UnpauseCall<'_> {
    type Reply = GidReply;
}

impl Call for UnpauseCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.unpause"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        Ok(())
    }
}

pub struct TellStatusCall<'a> {
    pub gid: Cow<'a, str>,
    pub keys: SmallVec<crate::status::StatusKey>,
}

impl Reply for TellStatusCall<'_> {
    type Reply = crate::status::Status;
}

impl Call for TellStatusCall<'_> {
    fn method(&self) -> &'static str {
        "aria2.tellStatus"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.gid)?;
        empty!(&self.keys, serializer);
        Ok(())
    }
}

#[derive(Debug, Default, Clone)]
pub struct TellActiveCall {
    pub keys: SmallVec<crate::status::StatusKey>,
}

impl Reply for TellActiveCall {
    type Reply = Vec<crate::status::Status>;
}

impl Call for TellActiveCall {
    fn method(&self) -> &'static str {
        "aria2.tellActive"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        empty!(&self.keys, serializer);
        Ok(())
    }
}

#[derive(Debug, Default, Clone)]
pub struct TellWaitingCall {
    pub offset: i32,
    pub num: i32,
    pub keys: SmallVec<crate::status::StatusKey>,
}

impl Reply for TellWaitingCall {
    type Reply = Vec<crate::status::Status>;
}

impl Call for TellWaitingCall {
    fn method(&self) -> &'static str {
        "aria2.tellWaiting"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.offset)?;
        serializer.serialize_element(&self.num)?;
        empty!(&self.keys, serializer);
        Ok(())
    }
}

#[derive(Debug, Default, Clone)]
pub struct TellStoppedCall {
    pub offset: i32,
    pub num: i32,
    pub keys: SmallVec<crate::status::StatusKey>,
}

impl Reply for TellStoppedCall {
    type Reply = Vec<crate::status::Status>;
}

impl Call for TellStoppedCall {
    fn method(&self) -> &'static str {
        "aria2.tellStopped"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        serializer.serialize_element(&self.offset)?;
        serializer.serialize_element(&self.num)?;
        empty!(&self.keys, serializer);
        Ok(())
    }
}

#[derive(Debug, Default, Clone)]
pub struct GetGlobalStatCall {
    pub keys: SmallVec<crate::status::StatKey>,
}

impl Reply for GetGlobalStatCall {
    type Reply = crate::status::Stat;
}

impl Call for GetGlobalStatCall {
    fn method(&self) -> &'static str {
        "aria2.getGlobalStat"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        empty!(&self.keys, serializer);
        Ok(())
    }
}

#[derive(Debug, Default, Clone, Copy)]
pub struct PurgeDownloadResultCall;

#[derive(Debug, Clone)]
pub enum OK {
    Ok,
    Err(String),
}

impl<'de> serde::de::Deserialize<'de> for OK {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        String::deserialize(deserializer).map(|s| if s == "OK" { OK::Ok } else { OK::Err(s) })
    }
}

impl Reply for PurgeDownloadResultCall {
    type Reply = OK;
}

impl Call for PurgeDownloadResultCall {
    fn method(&self) -> &'static str {
        "aria2.purgeDownloadResult"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        option!(token, serializer);
        Ok(())
    }
}

#[derive(Default)]
pub struct MultiCall<'a> {
    pub calls: Vec<Box<dyn Call + Send + Sync + 'a>>,
}

#[derive(Debug, Clone)]
pub struct MultiResponse(pub SmallVec<Value>);

impl<'de> Deserialize<'de> for MultiResponse {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let inner = SmallVec::<SmallVec<Value>>::deserialize(deserializer)?;
        Ok(MultiResponse(inner.into_iter().flatten().collect()))
    }
}

impl Reply for MultiCall<'_> {
    type Reply = MultiResponse;
}

impl<'a> MultiCall<'a> {
    pub const fn new() -> Self {
        Self { calls: Vec::new() }
    }
    pub fn push<T: Call + Send + Sync + 'a>(&mut self, call: T) {
        self.calls.push(Box::new(call));
    }
}

impl Call for MultiCall<'_> {
    fn method(&self) -> &'static str {
        "system.multicall"
    }
    fn serialize_params(
        &self,
        serializer: &mut SerializeSeq,
        token: Option<&str>,
    ) -> Result<(), JsonError> {
        #[derive(serde::Serialize)]
        struct MultiCallParam {
            #[serde(rename = "methodName")]
            method_name: &'static str,
            params: Value,
        }

        let mut values = SmallVec::with_capacity(self.calls.len());
        for call in &self.calls {
            let param = MultiCallParam {
                method_name: call.method(),
                params: call.to_param(token)?,
            };
            values.push(param);
        }
        serializer.serialize_element(&values)?;
        Ok(())
    }
}