// Buttplug Rust Source Code File - See https://buttplug.io for more info.
//
// Copyright 2016-2024 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 buttplug_core::{
  errors::ButtplugMessageError,
  message::{ButtplugMessage, ButtplugMessageFinalizer, ButtplugMessageValidator},
};
use getset::Getters;
use serde::{Deserialize, Serialize};

#[derive(
  Debug,
  Default,
  ButtplugMessage,
  ButtplugMessageFinalizer,
  Clone,
  PartialEq,
  Eq,
  Getters,
  Serialize,
  Deserialize,
)]
pub struct TestV0 {
  /// Message Id, used for matching message pairs in remote connection instances.
  #[serde(rename = "Id")]
  id: u32,
  /// Test string, which will be echoed back to client when sent to server.
  #[serde(rename = "TestString")]
  #[getset(get = "pub")]
  test_string: String,
}

impl TestV0 {
  /// Creates a new Test message with the given Id.
  pub fn new(test: &str) -> Self {
    Self {
      id: 1,
      test_string: test.to_owned(),
    }
  }
}

impl ButtplugMessageValidator for TestV0 {
  fn is_valid(&self) -> Result<(), ButtplugMessageError> {
    // Test could have any Id. There's really no validity check for this. What a
    // horrible message. So glad it's deprecated. :|
    Ok(())
  }
}