mirror of https://github.com/MingweiSamuel/Riven
Add match_v5::Participant champion(&self) method to handle bad champion IDs
Riot: https://github.com/RiotGames/developer-relations/issues/553 https://github.com/MingweiSamuel/Riven/issues/36pull/37/head
parent
de1e5cdbca
commit
2f4d1dc65c
|
@ -190,6 +190,7 @@ pub use error::*;
|
||||||
pub mod meta;
|
pub mod meta;
|
||||||
|
|
||||||
pub mod models;
|
pub mod models;
|
||||||
|
mod models_impls;
|
||||||
|
|
||||||
mod req;
|
mod req;
|
||||||
|
|
||||||
|
|
|
@ -820,6 +820,9 @@ pub mod match_v5 {
|
||||||
pub champ_level: i32,
|
pub champ_level: i32,
|
||||||
/// Prior to patch 11.4, on Feb 18th, 2021, this field returned invalid championIds. We recommend determining the champion based on the championName field for matches played prior to patch 11.4.
|
/// Prior to patch 11.4, on Feb 18th, 2021, this field returned invalid championIds. We recommend determining the champion based on the championName field for matches played prior to patch 11.4.
|
||||||
#[serde(rename = "championId")]
|
#[serde(rename = "championId")]
|
||||||
|
///
|
||||||
|
/// Instead use [`Self::champion()`] which checks this field then parses [`Self::champion_name`].
|
||||||
|
#[deprecated(since = "2.5.0", note = "Use `Participant.champion()` instead. Riot sometimes returns corrupted data for this field: https://github.com/RiotGames/developer-relations/issues/553")]
|
||||||
#[serde(serialize_with = "crate::consts::Champion::serialize_result")]
|
#[serde(serialize_with = "crate::consts::Champion::serialize_result")]
|
||||||
#[serde(deserialize_with = "crate::consts::Champion::deserialize_result")]
|
#[serde(deserialize_with = "crate::consts::Champion::deserialize_result")]
|
||||||
pub champion_id: Result<crate::consts::Champion, std::num::TryFromIntError>,
|
pub champion_id: Result<crate::consts::Champion, std::num::TryFromIntError>,
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
use crate::models::match_v5::Participant;
|
||||||
|
use crate::consts::Champion;
|
||||||
|
|
||||||
|
impl Participant {
|
||||||
|
/// This method takes the [`Self::champion_id`] field if it is valid
|
||||||
|
/// (`Ok`), otherwise it attempts to parse [`Self::champion_name`] and
|
||||||
|
/// returns the `Result`.
|
||||||
|
///
|
||||||
|
/// This is needed because some of Riot's [`Self::champion_id`] data is
|
||||||
|
/// corrupted, as they describe in the docs:
|
||||||
|
///
|
||||||
|
/// > Prior to patch 11.4, on Feb 18th, 2021, this field returned invalid
|
||||||
|
/// > championIds. We recommend determining the champion based on the
|
||||||
|
/// > championName field for matches played prior to patch 11.4.
|
||||||
|
///
|
||||||
|
/// This issue is reported here: <https://github.com/RiotGames/developer-relations/issues/553>.
|
||||||
|
pub fn champion(&self) -> Result<Champion, <Champion as std::str::FromStr>::Err> {
|
||||||
|
#[allow(deprecated)]
|
||||||
|
self.champion_id.or_else(|_| self.champion_name.parse())
|
||||||
|
}
|
||||||
|
}
|
|
@ -26,6 +26,7 @@ pub use error::*;
|
||||||
pub mod meta;
|
pub mod meta;
|
||||||
|
|
||||||
pub mod models;
|
pub mod models;
|
||||||
|
mod models_impls;
|
||||||
|
|
||||||
mod req;
|
mod req;
|
||||||
|
|
||||||
|
|
|
@ -59,6 +59,9 @@ pub mod {{= dotUtils.changeCase.snakeCase(endpoint) }} {
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
{{?}}
|
{{?}}
|
||||||
{{? 'championId' === propKey && (prop.description || '').includes('this field returned invalid championIds') }}
|
{{? 'championId' === propKey && (prop.description || '').includes('this field returned invalid championIds') }}
|
||||||
|
///
|
||||||
|
/// Instead use [`Self::champion()`] which checks this field then parses [`Self::champion_name`].
|
||||||
|
#[deprecated(since = "2.5.0", note = "Use `Participant.champion()` instead. Riot sometimes returns corrupted data for this field: https://github.com/RiotGames/developer-relations/issues/553")]
|
||||||
#[serde(serialize_with = "crate::consts::Champion::serialize_result")]
|
#[serde(serialize_with = "crate::consts::Champion::serialize_result")]
|
||||||
#[serde(deserialize_with = "crate::consts::Champion::deserialize_result")]
|
#[serde(deserialize_with = "crate::consts::Champion::deserialize_result")]
|
||||||
pub {{= name }}: Result<crate::consts::Champion, std::num::TryFromIntError>,
|
pub {{= name }}: Result<crate::consts::Champion, std::num::TryFromIntError>,
|
||||||
|
|
Loading…
Reference in New Issue