askiiart/torznab-toolkit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

figure out a bunch of weird stuff and doc it, add struct to hold torrent info

Browse source
This commit is contained in:
askiiart 2024-11-29 15:49:33 -06:00
parent 666ea1fd43
commit 8ad7ba87ac
Signed by untrusted user who does not match committer: askiiart
GPG key ID: EA85979611654C30
9 changed files with 155 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/lib.rs
View file

@ -1,23 +1,5 @@
#![warn(missing_docs)]
//! A toolkit for adding Torznab APIs to programs.
//!
//! Just fill in your own relevant functions and config, and
//! torznab-toolkit will run the API for you
//!
//! ```rs
//! use torznab_toolkit;
//! let config: torznab_toolkit::config::Config =
//!
//! ```
//!
//! The environment variables `ROCKET_ADDRESS` and `ROCKET_PORT` specify the address and port it will run on; these currently cannot be configured any other way. See the [relevant docs](https://rocket.rs/guide/v0.5/deploying/) for details.
//!
//! ---
//!
//! This program is brought to you by: metaphorical *and* literal truckloads of structs!
//!
//! Note: I wrote the line above when I was tired. Don't ask me what *literal* truckloads of structs means, I don't know either.
#![doc = include_str!("../README.md")]
pub mod api;
pub mod data;
mod dummy;
@ -42,3 +24,6 @@ pub async fn run(conf: data::Config) -> Result<bool, rocket::Error> {
}
}
}
/// Notes regarding the usage of torznab-toolkit and how it implements the Torznab API.
pub mod notes;