Skip to content

Commit cd84cf7

Browse files
committed
Improve consistent around using displaydoc::Display vs strum_macros::Display.
1 parent fee1309 commit cd84cf7

11 files changed

Lines changed: 19 additions & 21 deletions

File tree

crates/buttplug_core/src/connector/transport/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use crate::connector::{
1212
ButtplugConnectorResultFuture,
1313
ButtplugSerializedMessage,
1414
};
15-
use displaydoc::Display;
15+
use strum_macros::Display;
1616
use futures::future::BoxFuture;
1717
use thiserror::Error;
1818
use tokio::sync::mpsc::{Receiver, Sender};

crates/buttplug_core/src/errors.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ use super::message::{
1515
OutputType,
1616
serializer::ButtplugSerializerError,
1717
};
18+
use displaydoc::Display;
1819
use futures::future::BoxFuture;
1920
use serde::{Deserialize, Serialize};
2021
use thiserror::Error;
@@ -51,7 +52,7 @@ impl_error_to_future!(
5152
/// a remote network connection cannot be established), see
5253
/// [crate::connector::ButtplugConnectorError].
5354
54-
#[derive(Debug, Error, Display, Clone, PartialEq, Eq, Serialize, Deserialize)]
55+
#[derive(Display, Error, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
5556
pub enum ButtplugHandshakeError {
5657
/// Expected either a ServerInfo or Error message, received {0}
5758
UnexpectedHandshakeMessageReceived(String),
@@ -130,7 +131,7 @@ pub enum ButtplugDeviceError {
130131
DeviceCommunicationError(String),
131132
/// Device feature only has {0} steps for control, but {1} steps specified.
132133
DeviceStepRangeError(i32, i32),
133-
/// Device got {} output command but has no viable outputs
134+
/// Device got {0} output command but has no viable outputs
134135
DeviceNoOutputError(OutputType),
135136
/// Device got {0} input command but has no viable inputs
136137
DeviceNoInputError(InputType),

crates/buttplug_core/src/lib.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ pub mod errors;
1212
pub mod message;
1313
pub mod util;
1414

15-
#[macro_use]
16-
extern crate strum_macros;
17-
1815
use errors::ButtplugError;
1916
use futures::future::{self, BoxFuture, FutureExt};
2017

crates/buttplug_core/src/message/device_feature.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ use derive_builder::Builder;
1010
use getset::{CopyGetters, Getters, MutGetters, Setters};
1111
use serde::{Deserialize, Serialize};
1212
use std::hash::Hash;
13+
use strum_macros::{Display, EnumIter, EnumString};
1314

1415
#[derive(
1516
Debug, Display, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, Hash, EnumIter, EnumString,

crates/buttplug_core/src/message/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ use crate::errors::ButtplugMessageError;
2828
use enum_dispatch::enum_dispatch;
2929
use serde_repr::{Deserialize_repr, Serialize_repr};
3030
use std::convert::TryFrom;
31+
use strum_macros::Display;
3132

3233
use super::errors::ButtplugError;
3334

crates/buttplug_core/src/message/v4/input_cmd.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ use crate::message::{
1717
use getset::CopyGetters;
1818
use serde::{Deserialize, Deserializer, Serialize, Serializer, de::{SeqAccess, Visitor}, ser::SerializeSeq};
1919
use enumflags2::{BitFlags, bitflags};
20+
use strum_macros::Display;
2021

2122
#[bitflags]
2223
#[repr(u8)]

crates/buttplug_core/src/message/v4/input_reading.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use crate::message::{ButtplugDeviceMessage, ButtplugMessage, ButtplugMessageValidator, InputType};
99
use getset::{CopyGetters, Getters};
1010
use serde::{Deserialize, Serialize};
11+
use strum_macros::Display;
1112

1213
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, CopyGetters)]
1314
#[getset(get_copy = "pub")]

crates/buttplug_core/src/message/v4/output_cmd.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ use crate::{
1717
};
1818
use getset::CopyGetters;
1919
use serde::{Deserialize, Serialize};
20+
use strum_macros::Display;
2021

2122
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, CopyGetters)]
2223
#[getset(get_copy = "pub")]

crates/buttplug_core/src/message/v4/spec_enums.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ use crate::message::{
2222
};
2323
use enum_dispatch::enum_dispatch;
2424
use serde::{Deserialize, Serialize};
25+
use strum_macros::Display;
2526

2627
use super::{DeviceListV4, InputReadingV4};
2728

crates/buttplug_server_device_config/src/lib.rs

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -159,30 +159,26 @@ pub use endpoint::*;
159159
use uuid::Uuid;
160160

161161
use thiserror::Error;
162+
use displaydoc::Display;
162163

163-
#[derive(Error, Debug)]
164+
#[derive(Error, Debug, Display)]
164165
pub enum ButtplugDeviceConfigError {
165-
/// Conversion to client type not possible with requested property type
166-
#[error("Conversion of {0} to client type not possible with requested property type")]
166+
/// Conversion of {0} to client type not possible with requested property type
167167
InvalidOutputTypeConversion(String),
168168
/// User set range exceeds bounds of possible configuration range
169-
#[error("User set range exceeds bounds of possible configuration range")]
170169
InvalidUserRange,
171-
/// Base range required
172-
#[error("Base range required for all feature outputs")]
170+
/// Base range required for all feature outputs
173171
BaseRangeRequired,
174-
/// Base ID not found, cannot match user device/feature to a base device/feature
175-
#[error("Device definition with base id {0} not found")]
172+
/// Device definition with base id {0} not found
176173
BaseIdNotFound(Uuid),
177-
#[error("Feature vectors between base and user device definitions do not match")]
174+
/// Feature vectors between base and user device definitions do not match
178175
UserFeatureMismatch,
179-
#[error("Output value {0} not in range {1}")]
176+
/// Output value {0} not in range {1}
180177
InvalidOutputValue(i32, String),
181-
#[error("Output type {0} not available on device")]
178+
/// Output type {0} not available on device
182179
InvalidOutput(OutputType),
183-
#[error("Float value {0} is not 0 < x < 1")]
180+
/// Float value {0} is not 0 < x < 1
184181
InvalidFloatConversion(f64),
185182
/// Feature or device is missing required base_id for user config conversion
186-
#[error("Feature or device is missing required base_id for user config conversion")]
187183
MissingBaseId,
188184
}

0 commit comments

Comments
 (0)