botrs 0.12.0

A Rust QQ Bot framework based on QQ Guild Bot API
Documentation 
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

//! Message setting data models for the QQ Guild Bot API.

use crate::models::Snowflake;
use crate::models::serde_helpers::{is_false, is_zero_i32};
use serde::{Deserialize, Serialize};

/// Guild message frequency settings.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct MessageSetting {
    /// Whether creating direct messages is disabled.
    #[serde(default, skip_serializing_if = "is_false")]
    pub disable_create_dm: bool,
    /// Whether pushing messages is disabled.
    #[serde(default, skip_serializing_if = "is_false")]
    pub disable_push_msg: bool,
    /// Channel IDs covered by the setting.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub channel_ids: Vec<Snowflake>,
    /// Maximum number of pushed messages per channel.
    #[serde(default, skip_serializing_if = "is_zero_i32")]
    pub channel_push_max_num: i32,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn message_setting_uses_required_zero_value_fields() {
        let setting: MessageSetting = serde_json::from_value(serde_json::json!({})).unwrap();

        assert!(!setting.disable_create_dm);
        assert!(!setting.disable_push_msg);
        assert!(setting.channel_ids.is_empty());
        assert_eq!(setting.channel_push_max_num, 0);

        let value = serde_json::to_value(&setting).unwrap();
        assert!(value.as_object().unwrap().is_empty());
    }

    #[test]
    fn message_setting_keeps_official_json_shape() {
        let setting = MessageSetting {
            disable_create_dm: true,
            disable_push_msg: false,
            channel_ids: vec!["channel-1".to_string(), "channel-2".to_string()],
            channel_push_max_num: 10,
        };
        let value = serde_json::to_value(&setting).unwrap();

        assert_eq!(value["disable_create_dm"], true);
        assert!(value.get("disable_push_msg").is_none());
        assert_eq!(value["channel_ids"][0], "channel-1");
        assert_eq!(value["channel_push_max_num"], 10);
    }
}