hightorrent_api 0.3.0

Highlevel torrent API client, supporting Bittorrent v1, v2 and hybrid torrents
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

use hightorrent::{MagnetLink, TorrentFile};

use std::boxed::Box;

use crate::api_error::*;

/// `ApiAdd` is implemented by torrent API clients to add new torrents/magnets to the Bittorrent client.
///
/// It takes a single `AddBuilder` with an `AddSource`, and adds it to the torrent client, which is
/// a fallible operation.
///
/// This is the trait that backends should implement, but for convenience, `AddBuilder::send` will
/// perform the operation seamlessly:
///
/// ```ignore
/// let res = api.add().magnet(magnet_link).send().await;
/// ```
#[async_trait]
pub trait ApiAdd<'a>: Send + Sync {
    async fn api_add_send(&self, add: AddBuilder<'a, AddSource>) -> Result<(), ApiError>;
}

/// Dummy newtype used as `AddBuilder` generic type to prevent compilation
/// when no source has been added (typed builder pattern).
pub struct NoAddSource;

/// A source for torrent data to add to the Bittorrent backend.
pub enum AddSource {
    Magnet(Box<MagnetLink>),
    Torrent(Box<TorrentFile>),
}

pub struct AddBuilder<'a, T> {
    api: &'a dyn ApiAdd<'a>,
    #[allow(dead_code)]
    pub source: T,
    pub save_path: Option<String>,
    pub paused: Option<bool>,
    pub tags: Option<Vec<String>>,
}

impl<'a> AddBuilder<'a, NoAddSource> {
    pub fn new(api: &'a dyn ApiAdd<'a>) -> Self {
        AddBuilder {
            api,
            source: NoAddSource,
            save_path: None,
            paused: None,
            tags: None,
        }
    }
}

impl<'a> AddBuilder<'a, NoAddSource> {
    pub fn magnet(self, magnet: MagnetLink) -> AddBuilder<'a, AddSource> {
        let Self {
            api,
            save_path,
            paused,
            tags,
            ..
        } = self;
        AddBuilder {
            api,
            source: AddSource::Magnet(Box::new(magnet)),
            save_path,
            paused,
            tags,
        }
    }

    pub fn torrent(self, torrent: TorrentFile) -> AddBuilder<'a, AddSource> {
        let Self {
            api,
            save_path,
            paused,
            tags,
            ..
        } = self;
        AddBuilder {
            api,
            source: AddSource::Torrent(Box::new(torrent)),
            save_path,
            paused,
            tags,
        }
    }
}

impl<'a, S> AddBuilder<'a, S> {
    pub fn paused(mut self, p: bool) -> AddBuilder<'a, S> {
        self.paused = Some(p);
        self
    }

    pub fn tags(mut self, t: Vec<String>) -> AddBuilder<'a, S> {
        self.tags = Some(t);
        self
    }

    pub fn save_path(mut self, s: &str) -> AddBuilder<'a, S> {
        self.save_path = Some(s.to_string());
        self
    }
}

impl AddBuilder<'_, AddSource> {
    pub async fn send(self) -> Result<(), ApiError> {
        self.api.api_add_send(self).await
    }
}