108 lines
2.8 KiB
Rust
108 lines
2.8 KiB
Rust
//!
|
|
//! This crate provides everything necessary to download [torrents](https://en.wikipedia.org/wiki/BitTorrent).
|
|
//!
|
|
//! # Quick usage example
|
|
//!
|
|
//! ```no_run
|
|
//! 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.
|
|
//!
|
|
|
|
#![warn(clippy::cast_possible_truncation)]
|
|
|
|
macro_rules! aframe {
|
|
($e:expr) => {{
|
|
#[cfg(feature = "async-bt")]
|
|
{
|
|
async_backtrace::frame!($e)
|
|
}
|
|
#[cfg(not(feature = "async-bt"))]
|
|
{
|
|
$e
|
|
}
|
|
}};
|
|
}
|
|
|
|
pub mod api;
|
|
mod api_error;
|
|
mod bitv;
|
|
mod bitv_factory;
|
|
mod chunk_tracker;
|
|
mod create_torrent_file;
|
|
mod dht_utils;
|
|
pub mod file_info;
|
|
mod file_ops;
|
|
#[cfg(feature = "http-api")]
|
|
pub mod http_api;
|
|
#[cfg(feature = "http-api")]
|
|
pub mod http_api_client;
|
|
mod merge_streams;
|
|
mod peer_connection;
|
|
mod peer_info_reader;
|
|
mod read_buf;
|
|
mod session;
|
|
mod session_persistence;
|
|
pub mod session_stats;
|
|
mod spawn_utils;
|
|
pub mod storage;
|
|
mod stream_connect;
|
|
mod torrent_state;
|
|
#[cfg(feature = "tracing-subscriber-utils")]
|
|
pub mod tracing_subscriber_config_utils;
|
|
mod type_aliases;
|
|
#[cfg(all(feature = "http-api", feature = "upnp-serve-adapter"))]
|
|
pub mod upnp_server_adapter;
|
|
#[cfg(feature = "watch")]
|
|
pub mod watch;
|
|
|
|
pub use api::Api;
|
|
pub use api_error::ApiError;
|
|
pub use create_torrent_file::{create_torrent, CreateTorrentOptions};
|
|
pub use dht;
|
|
pub use peer_connection::PeerConnectionOptions;
|
|
pub use session::{
|
|
AddTorrent, AddTorrentOptions, AddTorrentResponse, ListOnlyResponse, Session, SessionOptions,
|
|
SessionPersistenceConfig, SUPPORTED_SCHEMES,
|
|
};
|
|
pub use spawn_utils::spawn as librqbit_spawn;
|
|
pub use torrent_state::{
|
|
ManagedTorrent, ManagedTorrentShared, ManagedTorrentState, TorrentStats, TorrentStatsState,
|
|
};
|
|
pub use type_aliases::FileInfos;
|
|
|
|
pub use buffers::*;
|
|
pub use clone_to_owned::CloneToOwned;
|
|
pub use librqbit_core::magnet::*;
|
|
pub use librqbit_core::peer_id::*;
|
|
pub use librqbit_core::torrent_metainfo::*;
|
|
|
|
#[cfg(test)]
|
|
mod tests;
|
|
|
|
/// The cargo version of librqbit.
|
|
pub const fn version() -> &'static str {
|
|
env!("CARGO_PKG_VERSION")
|
|
}
|
|
|
|
pub const fn client_name_and_version() -> &'static str {
|
|
concat!("rqbit ", env!("CARGO_PKG_VERSION"))
|
|
}
|
|
|
|
pub fn try_increase_nofile_limit() -> anyhow::Result<u64> {
|
|
Ok(rlimit::increase_nofile_limit(1024 * 1024)?)
|
|
}
|