This commit is contained in:
Thijs Molendijk 2021-07-04 20:10:50 +02:00 committed by Mingwei Samuel
parent 3c4f3c967a
commit 7f3fa7f59e
4 changed files with 646 additions and 100 deletions

File diff suppressed because it is too large Load diff

View file

@ -81,12 +81,28 @@
//! 9) Irelia 46465 (5) //! 9) Irelia 46465 (5)
//! 10) Vladimir 37176 (5) //! 10) Vladimir 37176 (5)
//! ``` //! ```
//! ### Feature Flags
//! //!
//! ### Nightly vs Stable //! #### Nightly vs Stable
//! //!
//! Enable the `nightly` feature to use nightly-only functionality. Mainly enables //! Enable the `nightly` feature to use nightly-only functionality. This enables
//! [nightly optimizations in the `parking_lot` crate](https://github.com/Amanieu/parking_lot#nightly-vs-stable). //! [nightly optimizations in the `parking_lot` crate](https://github.com/Amanieu/parking_lot#nightly-vs-stable).
//! Also required for running async integration tests. //!
//! ```toml
//! riven = { version = "...", features = [ "nightly" ] }
//! ```
//!
//! #### rustls
//!
//! Riven uses [reqwest](https://github.com/seanmonstar/reqwest) for making requests. By default, reqwest uses the native TLS library.
//! If you prefer using [rustls](https://github.com/ctz/rustls) you can do so by turning off the Riven default features
//! and specifying the `rustls-tls` feature:
//!
//! ```toml
//! riven = { version = "...", default-features = false, features = [ "rustls-tls" ] }
//! ```
//!
//! Riven is additionally able to produce [tracing](https://docs.rs/tracing) spans for requests if the `tracing` feature is enabled. This feature is disabled by default.
//! //!
//! ### Docs //! ### Docs
//! //!

View file

@ -7,7 +7,7 @@
/////////////////////////////////////////////// ///////////////////////////////////////////////
// http://www.mingweisamuel.com/riotapi-schema/tool/ // http://www.mingweisamuel.com/riotapi-schema/tool/
// Version f60af07c98f05dffdaf81262f9b01f97fe94a3a1 // Version 8fec9617c247f0ee5c96feecc8526fdc9dca0369
//! Metadata about the Riot API and Riven. //! Metadata about the Riot API and Riven.
//! //!

View file

@ -7,7 +7,7 @@
/////////////////////////////////////////////// ///////////////////////////////////////////////
// http://www.mingweisamuel.com/riotapi-schema/tool/ // http://www.mingweisamuel.com/riotapi-schema/tool/
// Version f60af07c98f05dffdaf81262f9b01f97fe94a3a1 // Version 8fec9617c247f0ee5c96feecc8526fdc9dca0369
//! Data transfer structs. //! Data transfer structs.
//! //!
@ -858,7 +858,7 @@ pub mod match_v4 {
/// 100 for blue side. 200 for red side. /// 100 for blue side. 200 for red side.
#[serde(rename = "teamId")] #[serde(rename = "teamId")]
pub team_id: crate::consts::Team, pub team_id: crate::consts::Team,
/// String indicating whether or not the team won. There are only two values visibile in public match history.<br> /// String indicating whether or not the team won. There are only two values visibile in public match history.<br>
/// (Legal values: Fail, Win) /// (Legal values: Fail, Win)
#[serde(rename = "win")] #[serde(rename = "win")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@ -903,7 +903,7 @@ pub mod match_v4 {
/// Second Summoner Spell id. /// Second Summoner Spell id.
#[serde(rename = "spell2Id")] #[serde(rename = "spell2Id")]
pub spell2_id: i32, pub spell2_id: i32,
/// Highest ranked tier achieved for the previous season in a specific subset of queueIds, if any, otherwise null. Used to display border in game loading screen. Please refer to the Ranked Info documentation.<br> /// Highest ranked tier achieved for the previous season in a specific subset of queueIds, if any, otherwise null. Used to display border in game loading screen. Please refer to the Ranked Info documentation.<br>
/// (Legal values: CHALLENGER, MASTER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE, UNRANKED) /// (Legal values: CHALLENGER, MASTER, DIAMOND, PLATINUM, GOLD, SILVER, BRONZE, UNRANKED)
#[serde(rename = "highestAchievedSeasonTier")] #[serde(rename = "highestAchievedSeasonTier")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@ -1257,7 +1257,7 @@ pub mod match_v4 {
#[serde(rename = "damageTakenPerMinDeltas")] #[serde(rename = "damageTakenPerMinDeltas")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub damage_taken_per_min_deltas: Option<std::collections::HashMap<String, f64>>, pub damage_taken_per_min_deltas: Option<std::collections::HashMap<String, f64>>,
/// Participant's calculated role.<br> /// Participant's calculated role.<br>
/// (Legal values: DUO, NONE, SOLO, DUO_CARRY, DUO_SUPPORT) /// (Legal values: DUO, NONE, SOLO, DUO_CARRY, DUO_SUPPORT)
#[serde(rename = "role")] #[serde(rename = "role")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@ -1274,7 +1274,7 @@ pub mod match_v4 {
#[serde(rename = "xpDiffPerMinDeltas")] #[serde(rename = "xpDiffPerMinDeltas")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub xp_diff_per_min_deltas: Option<std::collections::HashMap<String, f64>>, pub xp_diff_per_min_deltas: Option<std::collections::HashMap<String, f64>>,
/// Participant's calculated lane. MID and BOT are legacy values.<br> /// Participant's calculated lane. MID and BOT are legacy values.<br>
/// (Legal values: MID, MIDDLE, TOP, JUNGLE, BOT, BOTTOM) /// (Legal values: MID, MIDDLE, TOP, JUNGLE, BOT, BOTTOM)
#[serde(rename = "lane")] #[serde(rename = "lane")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@ -1831,6 +1831,9 @@ pub mod match_v5 {
pub queue_id: crate::consts::Queue, pub queue_id: crate::consts::Queue,
#[serde(rename = "teams")] #[serde(rename = "teams")]
pub teams: std::vec::Vec<MatchInfoTeam>, pub teams: std::vec::Vec<MatchInfoTeam>,
#[serde(rename = "tournamentCode")]
#[serde(skip_serializing_if = "Option::is_none")]
pub tournament_code: Option<String>,
} }
/// MatchTimelineInfoFrameEvent data object. /// MatchTimelineInfoFrameEvent data object.
#[derive(Debug)] #[derive(Debug)]
@ -2284,7 +2287,7 @@ pub mod spectator_v4 {
#[derive(Debug)] #[derive(Debug)]
#[derive(serde::Serialize, serde::Deserialize)] #[derive(serde::Serialize, serde::Deserialize)]
pub struct FeaturedGameInfo { pub struct FeaturedGameInfo {
/// The game mode<br> /// The game mode<br>
/// (Legal values: CLASSIC, ODIN, ARAM, TUTORIAL, ONEFORALL, ASCENSION, FIRSTBLOOD, KINGPORO) /// (Legal values: CLASSIC, ODIN, ARAM, TUTORIAL, ONEFORALL, ASCENSION, FIRSTBLOOD, KINGPORO)
#[serde(rename = "gameMode")] #[serde(rename = "gameMode")]
pub game_mode: crate::consts::GameMode, pub game_mode: crate::consts::GameMode,
@ -2294,7 +2297,7 @@ pub mod spectator_v4 {
/// The ID of the map /// The ID of the map
#[serde(rename = "mapId")] #[serde(rename = "mapId")]
pub map_id: crate::consts::Map, pub map_id: crate::consts::Map,
/// The game type<br> /// The game type<br>
/// (Legal values: CUSTOM_GAME, MATCHED_GAME, TUTORIAL_GAME) /// (Legal values: CUSTOM_GAME, MATCHED_GAME, TUTORIAL_GAME)
#[serde(rename = "gameType")] #[serde(rename = "gameType")]
pub game_type: crate::consts::GameType, pub game_type: crate::consts::GameType,
@ -2464,7 +2467,7 @@ pub mod tft_league_v1 {
pub summoner_name: String, pub summoner_name: String,
#[serde(rename = "queueType")] #[serde(rename = "queueType")]
pub queue_type: crate::consts::QueueType, pub queue_type: crate::consts::QueueType,
/// Only included for the RANKED_TFT_TURBO queueType.<br> /// Only included for the RANKED_TFT_TURBO queueType.<br>
/// (Legal values: ORANGE, PURPLE, BLUE, GREEN, GRAY) /// (Legal values: ORANGE, PURPLE, BLUE, GREEN, GRAY)
#[serde(rename = "ratedTier")] #[serde(rename = "ratedTier")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@ -2742,15 +2745,15 @@ pub mod tournament_stub_v4 {
/// The team size of the game. Valid values are 1-5. /// The team size of the game. Valid values are 1-5.
#[serde(rename = "teamSize")] #[serde(rename = "teamSize")]
pub team_size: i32, pub team_size: i32,
/// The pick type of the game.<br> /// The pick type of the game.<br>
/// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT) /// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT)
#[serde(rename = "pickType")] #[serde(rename = "pickType")]
pub pick_type: String, pub pick_type: String,
/// The map type of the game.<br> /// The map type of the game.<br>
/// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS) /// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS)
#[serde(rename = "mapType")] #[serde(rename = "mapType")]
pub map_type: String, pub map_type: String,
/// The spectator type of the game.<br> /// The spectator type of the game.<br>
/// (Legal values: NONE, LOBBYONLY, ALL) /// (Legal values: NONE, LOBBYONLY, ALL)
#[serde(rename = "spectatorType")] #[serde(rename = "spectatorType")]
pub spectator_type: String, pub spectator_type: String,
@ -2780,7 +2783,7 @@ pub mod tournament_stub_v4 {
#[derive(Debug)] #[derive(Debug)]
#[derive(serde::Serialize, serde::Deserialize)] #[derive(serde::Serialize, serde::Deserialize)]
pub struct ProviderRegistrationParameters { pub struct ProviderRegistrationParameters {
/// The region in which the provider will be running tournaments.<br> /// The region in which the provider will be running tournaments.<br>
/// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR) /// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR)
#[serde(rename = "region")] #[serde(rename = "region")]
pub region: String, pub region: String,
@ -2822,15 +2825,15 @@ pub mod tournament_v4 {
/// The team size of the game. Valid values are 1-5. /// The team size of the game. Valid values are 1-5.
#[serde(rename = "teamSize")] #[serde(rename = "teamSize")]
pub team_size: i32, pub team_size: i32,
/// The pick type of the game.<br> /// The pick type of the game.<br>
/// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT) /// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT)
#[serde(rename = "pickType")] #[serde(rename = "pickType")]
pub pick_type: String, pub pick_type: String,
/// The map type of the game.<br> /// The map type of the game.<br>
/// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS) /// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS)
#[serde(rename = "mapType")] #[serde(rename = "mapType")]
pub map_type: String, pub map_type: String,
/// The spectator type of the game.<br> /// The spectator type of the game.<br>
/// (Legal values: NONE, LOBBYONLY, ALL) /// (Legal values: NONE, LOBBYONLY, ALL)
#[serde(rename = "spectatorType")] #[serde(rename = "spectatorType")]
pub spectator_type: String, pub spectator_type: String,
@ -2869,7 +2872,7 @@ pub mod tournament_v4 {
/// The tournament code's ID. /// The tournament code's ID.
#[serde(rename = "id")] #[serde(rename = "id")]
pub id: i32, pub id: i32,
/// The tournament code's region.<br> /// The tournament code's region.<br>
/// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR) /// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR)
#[serde(rename = "region")] #[serde(rename = "region")]
pub region: String, pub region: String,
@ -2888,15 +2891,15 @@ pub mod tournament_v4 {
#[serde(rename = "allowedSummonerIds")] #[serde(rename = "allowedSummonerIds")]
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub allowed_summoner_ids: Option<std::vec::Vec<String>>, pub allowed_summoner_ids: Option<std::vec::Vec<String>>,
/// The pick type<br> /// The pick type<br>
/// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT) /// (Legal values: BLIND_PICK, DRAFT_MODE, ALL_RANDOM, TOURNAMENT_DRAFT)
#[serde(rename = "pickType")] #[serde(rename = "pickType")]
pub pick_type: String, pub pick_type: String,
/// The map type<br> /// The map type<br>
/// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS) /// (Legal values: SUMMONERS_RIFT, TWISTED_TREELINE, HOWLING_ABYSS)
#[serde(rename = "mapType")] #[serde(rename = "mapType")]
pub map_type: String, pub map_type: String,
/// The spectator type<br> /// The spectator type<br>
/// (Legal values: NONE, LOBBYONLY, ALL) /// (Legal values: NONE, LOBBYONLY, ALL)
#[serde(rename = "spectatorType")] #[serde(rename = "spectatorType")]
pub spectator_type: String, pub spectator_type: String,
@ -2926,7 +2929,7 @@ pub mod tournament_v4 {
#[derive(Debug)] #[derive(Debug)]
#[derive(serde::Serialize, serde::Deserialize)] #[derive(serde::Serialize, serde::Deserialize)]
pub struct ProviderRegistrationParameters { pub struct ProviderRegistrationParameters {
/// The region in which the provider will be running tournaments.<br> /// The region in which the provider will be running tournaments.<br>
/// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR) /// (Legal values: BR, EUNE, EUW, JP, LAN, LAS, NA, OCE, PBE, RU, TR)
#[serde(rename = "region")] #[serde(rename = "region")]
pub region: String, pub region: String,