Crate librqbit

Expand description

This crate provides everything necessary to download torrents.

Quick usage example

use librqbit::*;

tokio_test::block_on(async {
    let session = Session::new("/tmp/where-to-download".into()).await.unwrap();
    let managed_torrent_handle = session.add_torrent(
       AddTorrent::from_url("magnet:?xt=urn:btih:cab507494d02ebb1178b38f2e9d7be299c86b862"),
       None // options
    ).await.unwrap().into_handle().unwrap();
    managed_torrent_handle.wait_until_completed().await.unwrap();
})

Overview

The main type to start off with is Session.

It also proved useful to use the Api when building the rqbit desktop app, as it provides a facade that works with simple serializable types.

Re-exports

pub use api::Api;
pub use dht;

Modules

Structs

AddTorrentOptions
Options for adding new torrents to the session.
ApiError
AzureusStyle
ByteBuf
ByteString
ListOnlyResponse
Magnet
A parsed magnet link.
ManagedTorrent
PeerConnectionOptions
Session
SessionOptions
TorrentMetaV1
A parsed .torrent file.
TorrentMetaV1File
TorrentMetaV1Info
Main torrent information, shared by .torrent files and magnet link contents.

Enums

Constants

SUPPORTED_SCHEMES

Traits

Functions

generate_peer_id
librqbit_spawn
Spawn a future inside a tracing span, while logging it’s start, finish and periodically logging if it’s still alive.
torrent_from_bytes
Parse torrent metainfo from bytes.
try_decode_peer_id
try_increase_nofile_limit
version
The cargo version of librqbit.