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
//! Modio provides a set of building blocks for interacting with the [mod.io](https://mod.io) API. //! //! The client uses asynchronous I/O, backed by the `futures` and `tokio` crates, and requires both //! to be used alongside. //! //! # Authentication //! //! To access the API authentication is required and can be done via several ways: //! //! - Request an [API key (Read-only)](https://mod.io/apikey) //! - Manually create an [OAuth 2 Access Token (Read + Write)](https://mod.io/oauth) //! - [Email Authentication Flow](auth/struct.Auth.html#example) to create an OAuth 2 Access Token //! (Read + Write) //! - [External Authentication](auth::Auth::external) to create an OAuth 2 Access Token (Read + Write) //! automatically on platforms such as Steam, GOG, itch.io, Switch, Xbox, Discord and Oculus. //! //! # Rate Limiting //! //! - API keys linked to a game have **unlimited requests**. //! - API keys linked to a user have **60 requests per minute**. //! - OAuth2 user tokens are limited to **120 requests per minute**. //! //! [`Error::is_ratelimited`] will return true //! if the rate limit associated with credentials has been exhausted. //! //! # Example: Basic setup //! //! ```no_run //! use modio::{Credentials, Modio}; //! //! #[tokio::main] //! async fn main() -> Result<(), Box<dyn std::error::Error>> { //! let modio = Modio::new(Credentials::new("user-or-game-api-key"))?; //! //! // create some tasks and execute them //! // let result = task.await?; //! Ok(()) //! } //! ``` //! //! For testing purposes use [`Modio::host`] to create a client for the //! mod.io [test environment](https://docs.mod.io/#testing). //! //! # Example: Chaining api requests //! //! ```no_run //! use futures_util::future::try_join3; //! # #[tokio::main] //! # async fn main() -> Result<(), Box<dyn std::error::Error>> { //! # let modio = modio::Modio::new("user-or-game-api-key")?; //! //! // OpenXcom: The X-Com Files //! let modref = modio.mod_(51, 158); //! //! // Get mod with its dependencies and all files //! let deps = modref.dependencies().list(); //! let files = modref.files().search(Default::default()).collect(); //! let mod_ = modref.get(); //! //! let (m, deps, files) = try_join3(mod_, deps, files).await?; //! //! println!("{}", m.name); //! println!( //! "deps: {:?}", //! deps.into_iter().map(|d| d.mod_id).collect::<Vec<_>>() //! ); //! for file in files { //! println!("file id: {} version: {:?}", file.id, file.version); //! } //! # Ok(()) //! # } //! ``` //! //! # Example: Downloading mods //! //! ```no_run //! use modio::download::{DownloadAction, ResolvePolicy}; //! # #[tokio::main] //! # async fn main() -> Result<(), Box<dyn std::error::Error>> { //! # let modio = modio::Modio::new("user-or-game-api-key")?; //! //! // Download the primary file of a mod. //! let action = DownloadAction::Primary { //! game_id: 5, //! mod_id: 19, //! }; //! modio.download(action).save_to_file("mod.zip").await?; //! //! // Download the specific file of a mod. //! let action = DownloadAction::File { //! game_id: 5, //! mod_id: 19, //! file_id: 101, //! }; //! modio.download(action).save_to_file("mod.zip").await?; //! //! // Download the specific version of a mod. //! // if multiple files are found then the latest file is downloaded. //! // Set policy to `ResolvePolicy::Fail` to return with //! // `modio::download::Error::MultipleFilesFound` as source error. //! let action = DownloadAction::Version { //! game_id: 5, //! mod_id: 19, //! version: "0.1".to_string(), //! policy: ResolvePolicy::Latest, //! }; //! modio.download(action).save_to_file("mod.zip").await?; //! # Ok(()) //! # } //! ``` #![doc(html_root_url = "https://docs.rs/modio/0.6.0")] #![deny(rust_2018_idioms)] #![cfg_attr(docsrs, deny(broken_intra_doc_links))] #[macro_use] mod macros; pub mod auth; #[macro_use] pub mod filter; pub mod comments; pub mod download; pub mod files; pub mod games; pub mod metadata; pub mod mods; pub mod reports; pub mod teams; pub mod user; mod client; mod error; mod loader; mod multipart; mod request; mod routing; mod types; pub use crate::auth::Credentials; pub use crate::client::{Builder, Modio}; pub use crate::download::DownloadAction; pub use crate::error::{Error, Result}; pub use crate::loader::{Page, Query}; pub use crate::types::{Deletion, Editing}; mod prelude { pub use futures_core::Stream; pub use reqwest::multipart::Form; pub use reqwest::StatusCode; pub use crate::filter::Filter; pub use crate::loader::Query; pub use crate::routing::Route; pub use crate::types::Message; pub use crate::{Deletion, Editing, Modio, Result}; } /// Re-exports of the used reqwest types. #[doc(hidden)] pub mod lib { pub use reqwest::header; pub use reqwest::redirect::Policy; pub use reqwest::ClientBuilder; #[cfg(feature = "__tls")] pub use reqwest::{Certificate, Identity}; pub use reqwest::{Proxy, Url}; }