diff options
| author | Zeyla Hellyer <[email protected]> | 2017-04-11 08:15:37 -0700 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-04-11 10:52:43 -0700 |
| commit | f6b27eb39c042e6779edc2d5d4b6e6c27d133eaf (patch) | |
| tree | a6169fee3bf9ea75391101577dcb2982e3daa388 /src/model/utils.rs | |
| parent | Clippy lints + permission byte literals (diff) | |
| download | serenity-f6b27eb39c042e6779edc2d5d4b6e6c27d133eaf.tar.xz serenity-f6b27eb39c042e6779edc2d5d4b6e6c27d133eaf.zip | |
Switch to using serde for deserialization
The current build system is rudimentary, incomplete, and rigid, offering
little in the way of customizing decoding options.
To solve this, switch to using serde-derive with custom Deserialization
implementations. This allows very simple deserialization when special
logic does not need to be applied, yet allows us to implement our own
deserialization logic when required.
The problem with the build system was that it built enums and structs
from YAML files. This is not so good, because it requires creating a
custom build system (which was rudimentary), creating "special struct
configs" when logic needed to be ever so slightly extended (rigid), and
if special logic needed to be applied, a custom deserialization method
would have been needed to be made anyway (incomplete).
To solve this, switch to serde-derive and implementing Deserialize
ourselves where required. This reduces YAML definitions that might
look like:
```yaml
---
name: Group
description: >
A group channel, potentially including other users, separate from a [`Guild`].
[`Guild`]: struct.Guild.html
fields:
- name: channel_id
description: The Id of the group channel.
from: id
type: ChannelId
- name: icon
description: The optional icon of the group channel.
optional: true
type: string
- name: last_message_id
description: The Id of the last message sent.
optional: true
type: MessageId
- name: last_pin_timestamp
description: Timestamp of the latest pinned message.
optional: true
type: string
- name: name
description: The name of the group channel.
optional: true
type: string
- name: owner_id
description: The Id of the group channel creator.
type: UserId
- name: recipients
description: Group channel's members.
custom: decode_users
t: UserId, Arc<RwLock<User>>
type: hashmap
```
to:
```rs
/// A group channel - potentially including other [`User`]s - separate from a
/// [`Guild`].
///
/// [`Guild`]: struct.Guild.html
/// [`User`]: struct.User.html
pub struct Group {
/// The Id of the group channel.
#[serde(rename="id")]
pub channel_id: ChannelId,
/// The optional icon of the group channel.
pub icon: Option<String>,
/// The Id of the last message sent.
pub last_message_id: Option<MessageId>,
/// Timestamp of the latest pinned message.
pub last_pin_timestamp: Option<String>,
/// The name of the group channel.
pub name: Option<String>,
/// The Id of the group owner.
pub owner_id: UserId,
/// A map of the group's recipients.
#[serde(deserialize_with="deserialize_users")]
pub recipients: HashMap<UserId, Arc<RwLock<User>>>,
}
```
This is much simpler and does not have as much boilerplate.
There should not be any backwards incompatible changes other than the
old, public - yet undocumented (and hidden from documentation) - decode
methods being removed. Due to the nature of this commit, field names may
be incorrect, and will need to be corrected as deserialization errors
are found.
Diffstat (limited to 'src/model/utils.rs')
| -rw-r--r-- | src/model/utils.rs | 165 |
1 files changed, 48 insertions, 117 deletions
diff --git a/src/model/utils.rs b/src/model/utils.rs index cbae244..ab7a8fb 100644 --- a/src/model/utils.rs +++ b/src/model/utils.rs @@ -1,69 +1,46 @@ -use std::collections::{BTreeMap, HashMap}; +use serde::de::Error as DeError; +use std::collections::HashMap; use std::sync::{Arc, RwLock}; use super::*; + +#[cfg(feature="cache")] use ::internal::prelude::*; -use ::utils::{decode_array, into_array}; #[cfg(feature="cache")] use super::permissions::{self, Permissions}; #[cfg(feature="cache")] use ::client::CACHE; -#[macro_escape] -macro_rules! req { - ($opt:expr) => { - $opt.ok_or(Error::Decode(concat!("Type mismatch in model:", - line!(), - ": ", - stringify!($opt)), - Value::Null))? - } -} - -pub fn decode_emojis(value: Value) -> Result<HashMap<EmojiId, Emoji>> { +pub fn deserialize_emojis<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<EmojiId, Emoji>, D::Error> { + let vec: Vec<Emoji> = Deserialize::deserialize(deserializer)?; let mut emojis = HashMap::new(); - for emoji in decode_array(value, Emoji::decode)? { + for emoji in vec { emojis.insert(emoji.id, emoji); } Ok(emojis) } -pub fn decode_id(value: Value) -> Result<u64> { - match value { - Value::U64(num) => Ok(num), - Value::I64(num) => Ok(num as u64), - Value::String(text) => match text.parse::<u64>() { - Ok(num) => Ok(num), - Err(_) => Err(Error::Decode("Expected numeric ID", - Value::String(text))) - }, - value => Err(Error::Decode("Expected numeric ID", value)) - } -} +pub fn deserialize_guild_channels<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<ChannelId, Arc<RwLock<GuildChannel>>>, D::Error> { + let vec: Vec<GuildChannel> = Deserialize::deserialize(deserializer)?; + let mut map = HashMap::new(); -pub fn decode_members(value: Value) -> Result<HashMap<UserId, Member>> { - let mut members = HashMap::new(); - - for member in decode_array(value, Member::decode)? { - let user_id = member.user.read().unwrap().id; - - members.insert(user_id, member); + for channel in vec { + map.insert(channel.id, Arc::new(RwLock::new(channel))); } - Ok(members) + Ok(map) } -pub fn decode_guild_members(guild_id: GuildId, value: Value) -> Result<HashMap<UserId, Member>> { +pub fn deserialize_members<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<UserId, Member>, D::Error> { + let vec: Vec<Member> = Deserialize::deserialize(deserializer)?; let mut members = HashMap::new(); - let member_vec = into_array(value).map(|x| x - .into_iter() - .map(|v| Member::decode_guild(guild_id, v)) - .filter_map(Result::ok) - .collect::<Vec<_>>())?; - for member in member_vec { + for member in vec { let user_id = member.user.read().unwrap().id; members.insert(user_id, member); @@ -72,21 +49,24 @@ pub fn decode_guild_members(guild_id: GuildId, value: Value) -> Result<HashMap<U Ok(members) } -pub fn decode_presences(value: Value) -> Result<HashMap<UserId, Presence>> { +pub fn deserialize_presences<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<UserId, Presence>, D::Error> { + let vec: Vec<Presence> = Deserialize::deserialize(deserializer)?; let mut presences = HashMap::new(); - for presence in decode_array(value, Presence::decode)? { + for presence in vec { presences.insert(presence.user_id, presence); } Ok(presences) } -pub fn decode_private_channels(value: Value) - -> Result<HashMap<ChannelId, Channel>> { +pub fn deserialize_private_channels<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<ChannelId, Channel>, D::Error> { + let vec: Vec<Channel> = Deserialize::deserialize(deserializer)?; let mut private_channels = HashMap::new(); - for private_channel in decode_array(value, Channel::decode)? { + for private_channel in vec { let id = match private_channel { Channel::Group(ref group) => group.read().unwrap().channel_id, Channel::Private(ref channel) => channel.read().unwrap().id, @@ -99,103 +79,54 @@ pub fn decode_private_channels(value: Value) Ok(private_channels) } -pub fn decode_roles(value: Value) -> Result<HashMap<RoleId, Role>> { +pub fn deserialize_roles<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<RoleId, Role>, D::Error> { + let vec: Vec<Role> = Deserialize::deserialize(deserializer)?; let mut roles = HashMap::new(); - for role in decode_array(value, Role::decode)? { + for role in vec { roles.insert(role.id, role); } Ok(roles) } -pub fn decode_shards(value: Value) -> Result<[u64; 2]> { - let array = into_array(value)?; +pub fn deserialize_single_recipient<D: Deserializer>(deserializer: D) + -> StdResult<Arc<RwLock<User>>, D::Error> { + let mut users: Vec<User> = Deserialize::deserialize(deserializer)?; + let user = if users.is_empty() { + return Err(DeError::custom("Expected a single recipient")); + } else { + users.remove(0) + }; - Ok([ - req!(array.get(0) - .ok_or(Error::Client(ClientError::InvalidShards))?.as_u64()) as u64, - req!(array.get(1) - .ok_or(Error::Client(ClientError::InvalidShards))?.as_u64()) as u64, - ]) + Ok(Arc::new(RwLock::new(user))) } -pub fn decode_users(value: Value) -> Result<HashMap<UserId, Arc<RwLock<User>>>> { +pub fn deserialize_users<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<UserId, Arc<RwLock<User>>>, D::Error> { + let vec: Vec<User> = Deserialize::deserialize(deserializer)?; let mut users = HashMap::new(); - for user in decode_array(value, User::decode)? { + for user in vec { users.insert(user.id, Arc::new(RwLock::new(user))); } Ok(users) } -pub fn decode_voice_states(value: Value) - -> Result<HashMap<UserId, VoiceState>> { +pub fn deserialize_voice_states<D: Deserializer>(deserializer: D) + -> StdResult<HashMap<UserId, VoiceState>, D::Error> { + let vec: Vec<VoiceState> = Deserialize::deserialize(deserializer)?; let mut voice_states = HashMap::new(); - for voice_state in decode_array(value, VoiceState::decode)? { + for voice_state in vec { voice_states.insert(voice_state.user_id, voice_state); } Ok(voice_states) } -pub fn into_string(value: Value) -> Result<String> { - match value { - Value::String(s) => Ok(s), - Value::U64(v) => Ok(v.to_string()), - Value::I64(v) => Ok(v.to_string()), - value => Err(Error::Decode("Expected string", value)), - } -} - -pub fn into_map(value: Value) -> Result<BTreeMap<String, Value>> { - match value { - Value::Object(m) => Ok(m), - value => Err(Error::Decode("Expected object", value)), - } -} - -pub fn into_u64(value: Value) -> Result<u64> { - match value { - Value::I64(v) => Ok(v as u64), - Value::String(v) => match v.parse::<u64>() { - Ok(v) => Ok(v), - Err(_) => Err(Error::Decode("Expected valid u64", Value::String(v))), - }, - Value::U64(v) => Ok(v), - value => Err(Error::Decode("Expected u64", value)), - } -} - -pub fn opt<F, T>(map: &mut BTreeMap<String, Value>, key: &str, f: F) - -> Result<Option<T>> where F: FnOnce(Value) -> Result<T> { - match map.remove(key) { - None | Some(Value::Null) => Ok(None), - Some(val) => f(val).map(Some), - } -} - -pub fn decode_discriminator(value: Value) -> Result<u16> { - match value { - Value::I64(v) => Ok(v as u16), - Value::U64(v) => Ok(v as u16), - Value::String(s) => match s.parse::<u16>() { - Ok(v) => Ok(v), - Err(_) => Err(Error::Decode("Error parsing discriminator as u16", - Value::String(s))), - }, - value => Err(Error::Decode("Expected string or u64", value)), - } -} - -pub fn remove(map: &mut BTreeMap<String, Value>, key: &str) -> Result<Value> { - map.remove(key).ok_or_else(|| { - Error::Decode("Unexpected absent key", Value::String(key.into())) - }) -} - #[cfg(feature="cache")] pub fn user_has_perms(channel_id: ChannelId, mut permissions: Permissions) |