torrent 0.1.5

High-level async BitTorrent library — session management, HTTP/UDP tracker communication, DHT networking, peer connections, and file storage. Built on torrent-core with tokio.
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

//! Integration tests for the Session API.

use torrent::bencode::{Bencode, Bytes, encode};
use torrent::error::{Error, ErrorKind};
use torrent::session::{Session, SessionConfig, TorrentState};

/// Helper: build synthetic single-file .torrent data.
fn make_single_file_torrent() -> Vec<u8> {
    let info_dict = Bencode::Dict(vec![
        (Bytes::from("name"), Bencode::Bytes(Bytes::from("test.txt"))),
        (Bytes::from("piece length"), Bencode::Integer(16384)),
        (Bytes::from("length"), Bencode::Integer(1024)),
        (
            Bytes::from("pieces"),
            Bencode::Bytes(Bytes::from(vec![0u8; 20])),
        ),
    ]);
    let root = Bencode::Dict(vec![
        (
            Bytes::from("announce"),
            Bencode::Bytes(Bytes::from("http://tracker.example.com/announce")),
        ),
        (Bytes::from("info"), info_dict),
    ]);
    encode(&root)
}

#[tokio::test]
async fn session_config_defaults() {
    let cfg = SessionConfig::default();
    assert_eq!(cfg.listen_port, 6881);
    assert_eq!(cfg.max_connections, 50);
    assert_eq!(cfg.max_uploads, 8);
    assert!(cfg.bootstrap_nodes.is_some());
}

#[tokio::test]
async fn session_new_with_temp_dir() -> Result<(), Error> {
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;
    assert!(session.active_torrents().await.is_empty());
    Ok(())
}

#[tokio::test]
async fn add_torrent_bytes_and_query_status() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let data = make_single_file_torrent();
    let info_hash = session.add_torrent_bytes(&data, tmp.path()).await?;

    // Verify the torrent appears in active list
    let active = session.active_torrents().await;
    assert_eq!(active.len(), 1);
    assert_eq!(active[0], info_hash);

    // Query its status
    let status = session.torrent_status(&info_hash).await?;
    assert_eq!(status.info_hash, info_hash);
    assert_eq!(status.name, "test.txt");
    assert_eq!(status.state, TorrentState::Queued);
    assert_eq!(status.progress, 0.0);

    Ok(())
}

#[tokio::test]
async fn remove_torrent() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let data = make_single_file_torrent();
    let info_hash = session.add_torrent_bytes(&data, tmp.path()).await?;
    assert_eq!(session.active_torrents().await.len(), 1);

    session.remove_torrent(&info_hash).await?;
    assert!(session.active_torrents().await.is_empty());

    // Querying a removed torrent should fail
    let err = session.torrent_status(&info_hash).await.unwrap_err();
    assert_eq!(err.kind(), ErrorKind::InvalidInput);

    Ok(())
}

#[tokio::test]
async fn add_and_query_multiple_times() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let data = make_single_file_torrent();
    let info_hash = session.add_torrent_bytes(&data, tmp.path()).await?;

    // Query status multiple times — should be consistent
    for _ in 0..3 {
        let status = session.torrent_status(&info_hash).await?;
        assert_eq!(status.info_hash, info_hash);
        assert_eq!(status.state, TorrentState::Queued);
    }

    Ok(())
}

// --- Magnet URI tests ---

#[tokio::test]
async fn add_magnet_str_minimal() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let info_hash = session
        .add_magnet_str(
            "magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567",
            tmp.path(),
        )
        .await?;

    let active = session.active_torrents().await;
    assert_eq!(active.len(), 1);
    assert_eq!(active[0], info_hash);

    let status = session.torrent_status(&info_hash).await?;
    assert_eq!(status.info_hash, info_hash);
    assert_eq!(status.state, TorrentState::Queued);
    assert_eq!(status.progress, 0.0);

    Ok(())
}

#[tokio::test]
async fn add_magnet_str_with_trackers() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let info_hash = session
        .add_magnet_str(
            "magnet:?xt=urn:btih:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\
             &tr=http://t1.com/ann&tr=http://t2.com/ann",
            tmp.path(),
        )
        .await?;

    assert!(session.active_torrents().await.contains(&info_hash));
    let status = session.torrent_status(&info_hash).await?;
    assert_eq!(status.state, TorrentState::Queued);

    Ok(())
}

#[tokio::test]
async fn add_magnet_str_invalid() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    // No xt parameter — should fail
    let result = session
        .add_magnet_str("magnet:?dn=no_hash", tmp.path())
        .await;
    assert!(result.is_err());

    Ok(())
}

#[tokio::test]
async fn add_magnet_str_with_display_name() -> Result<(), Error> {
    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let info_hash = session
        .add_magnet_str(
            "magnet:?xt=urn:btih:cccccccccccccccccccccccccccccccccccccccc&dn=Test+File",
            tmp.path(),
        )
        .await?;

    let status = session.torrent_status(&info_hash).await?;
    assert_eq!(status.name, "Test+File");

    Ok(())
}

#[tokio::test]
async fn magnet_via_add_torrent() -> Result<(), Error> {
    use std::str::FromStr;
    use torrent::magnet::MagnetUri;

    let tmp = tempfile::tempdir().unwrap();
    let config = SessionConfig {
        bootstrap_nodes: None,
        ..Default::default()
    };
    let session = Session::new(config).await?;

    let magnet = MagnetUri::from_str(
        "magnet:?xt=urn:btih:dddddddddddddddddddddddddddddddddddddddd&dn=Direct",
    )
    .unwrap();
    let info_hash = *magnet.primary_info_hash();

    session.add_torrent(magnet, tmp.path()).await?;

    let status = session.torrent_status(&info_hash).await?;
    assert_eq!(status.name, "Direct");

    Ok(())
}