buttplug_core 10.0.2

Buttplug Intimate Hardware Control Library - Core Library
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
78
79
80
81
82
83
84
85

// Buttplug Rust Source Code File - See https://buttplug.io for more info.
//
// Copyright 2016-2026 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 crate::message::{
  ButtplugDeviceMessage,
  ButtplugMessage,
  ButtplugMessageError,
  ButtplugMessageValidator,
  InputType,
};
use getset::CopyGetters;
use serde::{Deserialize, Serialize};

#[derive(Debug, Display, PartialEq, Eq, Clone, Serialize, Deserialize, Hash, Copy)]
pub enum InputCommandType {
  #[serde(alias = "read")]
  Read,
  #[serde(alias = "subscribe")]
  Subscribe,
  #[serde(alias = "unsubscribe")]
  Unsubscribe,
}

#[derive(Debug, PartialEq, Eq, Clone, Copy, CopyGetters, Serialize, Deserialize)]
pub struct InputCmdV4 {
  #[serde(rename = "Id")]
  id: u32,
  #[serde(rename = "DeviceIndex")]
  device_index: u32,
  #[getset(get_copy = "pub")]
  #[serde(rename = "FeatureIndex")]
  feature_index: u32,
  #[getset(get_copy = "pub")]
  #[serde(rename = "Type")]
  input_type: InputType,
  #[getset(get_copy = "pub")]
  #[serde(rename = "Command")]
  input_command: InputCommandType,
}

impl InputCmdV4 {
  pub fn new(
    device_index: u32,
    feature_index: u32,
    input_type: InputType,
    input_command_type: InputCommandType,
  ) -> Self {
    Self {
      id: 1,
      device_index,
      feature_index,
      input_type,
      input_command: input_command_type,
    }
  }
}

impl ButtplugMessage for InputCmdV4 {
  fn id(&self) -> u32 {
    self.id
  }
  fn set_id(&mut self, id: u32) {
    self.id = id;
  }
}

impl ButtplugDeviceMessage for InputCmdV4 {
  fn device_index(&self) -> u32 {
    self.device_index
  }
  fn set_device_index(&mut self, device_index: u32) {
    self.device_index = device_index;
  }
}

impl ButtplugMessageValidator for InputCmdV4 {
  fn is_valid(&self) -> Result<(), ButtplugMessageError> {
    self.is_not_system_id(self.id)
    // TODO Should expected_length always be > 0?
  }
}