buttplug 0.2.0

Buttplug Intimate Hardware Control Library
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

// Buttplug Rust Source Code File - See https://buttplug.io for more info.
//
// Copyright 2016-2020 Nonpolynomial Labs LLC. All rights reserved.
//
// Licensed under the BSD 3-Clause license. See LICENSE file in the project root
// for full license information.

use super::*;
#[cfg(feature = "serialize_json")]
use serde::{Deserialize, Serialize};

fn return_version0() -> ButtplugMessageSpecVersion {
    ButtplugMessageSpecVersion::Version0
}

#[derive(Debug, ButtplugMessage, Clone, PartialEq)]
#[cfg_attr(feature = "serialize_json", derive(Serialize, Deserialize))]
pub struct RequestServerInfo {
    #[cfg_attr(feature = "serialize_json", serde(rename = "Id"))]
    pub(super) id: u32,
    #[cfg_attr(feature = "serialize_json", serde(rename = "ClientName"))]
    pub client_name: String,
    // Default for this message is set to 0, as this field didn't exist in the
    // first version of the protocol.
    #[cfg_attr(feature = "serialize_json", serde(rename = "MessageVersion"), serde(default = "return_version0"))]
    pub message_version: ButtplugMessageSpecVersion,
}

impl RequestServerInfo {
    pub fn new(client_name: &str, message_version: ButtplugMessageSpecVersion) -> Self {
        Self {
            id: 1,
            client_name: client_name.to_string(),
            message_version,
        }
    }
}

#[cfg(test)]
mod test {
    use super::{RequestServerInfo, ButtplugMessageSpecVersion};

    #[cfg(feature = "serialize_json")]
    #[test]
    fn test_request_server_info_version1_json_conversion() {
        let new_json = r#"
{
        "Id": 1,
        "ClientName": "Test Client",
        "MessageVersion": 2
}
        "#;
        let new_msg = RequestServerInfo {
            id: 1,
            client_name: "Test Client".to_owned(),
            message_version: ButtplugMessageSpecVersion::Version2
        };
        assert_eq!(serde_json::from_str::<RequestServerInfo>(new_json).unwrap(), new_msg);
    }

    #[cfg(feature = "serialize_json")]
    #[test]
    fn test_request_server_info_version0_json_conversion() {
        let old_json = r#"
{
        "Id": 1,
        "ClientName": "Test Client"
}
        "#;
        let old_msg = RequestServerInfo {
            id: 1,
            client_name: "Test Client".to_owned(),
            message_version: ButtplugMessageSpecVersion::Version0
        };
        assert_eq!(serde_json::from_str::<RequestServerInfo>(old_json).unwrap(), old_msg);
    }
}