hightorrent 0.3.1

High-level torrent library which supports 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

//! HighTorrent is a library which contains high-level data structures and functions
//! to interact with Bittorrent v1 and v2 torrents. HighTorrent does not aim to be featureful,
//! but rather to be super easy to use and interoperate with more advanced torrent software,
//! and completely impossible to misuse.
//!
//! **Note that HighTorrent is not a networked library. It will not provide any utilities for
//! querying the DHT and/or downloading torrents. HighTorrent is much lower in the stack.**
//!
//! HighTorrent provides utilities to extract name and hash from torrents/magnets, using the
//! [`MagnetLink`](crate::magnet::MagnetLink) and [`TorrentFile`](crate::torrent_file::TorrentFile) structures, but could provide more advanced utilities in the future (PRs welcome). Additionally, it provides the [`Torrent`](crate::torrent::Torrent) struct and the
//! [`ToTorrent`](crate::torrent::ToTorrent) trait representing fully-loaded torrents ; those helpers are intended to be used by more diverse torrenting libraries to provide interoperability out-of-the-box.
//!
//! Finally, the [`SingleTarget`](crate::target::SingleTarget) and
//! [`MultiTarget`](crate::target::MultiTarget) structures represent one or more torrents you wish to
//! interact with. The contained stringy value is ambiguous, and can represent either a precise
//! [`InfoHash`](crate::hash::InfoHash) or a libtorrent-compatible [`TorrentID`](crate::id::TorrentID) (truncated hash).

#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![allow(rustdoc::redundant_explicit_links)]

#[macro_use]
extern crate serde;

mod hash;
pub use hash::{InfoHash, InfoHashError, TryInfoHash};

mod id;
pub use id::TorrentID;

mod list;
pub use list::TorrentList;

mod magnet;
pub use magnet::{MagnetLink, MagnetLinkError};

mod piece_length;
pub use piece_length::{PieceLength, PIECE_LENGTH_MAXIMUM};

mod torrent;
pub use torrent::{ToTorrent, ToTorrentContent, Torrent, TorrentContent};

mod torrent_file;
pub use torrent_file::{TorrentFile, TorrentFileError};

mod target;
pub use target::{MultiTarget, SingleTarget, ToSingleTarget};

mod tracker;
pub use tracker::{PeerSource, Tracker, TrackerError, TrackerScheme, TryIntoTracker};