Derive Clone, PartialEq, Eq, and Hash where appropriate.

This is really useful for anyone who wishes to use the steven_protocol crate and write tests that compare packets to expected values.
iceiix · Feb 5, 2022 · 9a8d357 · 9a8d357
1 parent 00e7a3d
commit 9a8d357
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 62 deletions.
diff --git a/protocol/src/format.rs b/protocol/src/format.rs
@@ -15,7 +15,7 @@
 use std::fmt;
 use std::mem;
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub enum Component {
     Text(TextComponent),
 }
@@ -115,7 +115,7 @@ impl Default for Component {
     }
 }
 
-#[derive(Debug, Default, Clone)]
+#[derive(Debug, Default, Clone, PartialEq, Eq)]
 pub struct Modifier {
     pub extra: Option<Vec<Component>>,
     pub bold: Option<bool>,
@@ -159,7 +159,7 @@ impl Modifier {
     }
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct TextComponent {
     pub text: String,
     pub modifier: Modifier,
@@ -199,7 +199,7 @@ impl fmt::Display for TextComponent {
     }
 }
 
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub enum Color {
     Black,
     DarkBlue,

diff --git a/protocol/src/item.rs b/protocol/src/item.rs
@@ -17,7 +17,7 @@ use crate::protocol::{self, Serializable};
 use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
 use std::io;
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct Stack {
     pub id: isize,
     pub count: isize,

diff --git a/protocol/src/nbt/mod.rs b/protocol/src/nbt/mod.rs
@@ -20,7 +20,7 @@ use super::protocol;
 use super::protocol::Serializable;
 use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub enum Tag {
     End,
     Byte(i8),
@@ -37,7 +37,7 @@ pub enum Tag {
     LongArray(Vec<i64>),
 }
 
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct NamedTag(pub String, pub Tag);
 
 impl Tag {

diff --git a/protocol/src/protocol/forge.rs b/protocol/src/protocol/forge.rs
@@ -5,7 +5,7 @@ use std::io;
 
 use super::{Error, LenPrefixed, Serializable, VarInt};
 
-#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
 pub enum Phase {
     // Client handshake states (written)
     Start,
@@ -44,7 +44,7 @@ impl Serializable for Phase {
     }
 }
 
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
 pub struct ForgeMod {
     pub modid: String,
     pub version: String,
@@ -64,7 +64,7 @@ impl Serializable for ForgeMod {
     }
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct ModIdMapping {
     pub name: String,
     pub id: VarInt,
@@ -87,7 +87,7 @@ impl Serializable for ModIdMapping {
 pub static BLOCK_NAMESPACE: &str = "\u{1}";
 pub static ITEM_NAMESPACE: &str = "\u{2}";
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub enum FmlHs {
     ServerHello {
         fml_protocol_version: i8,
@@ -196,7 +196,7 @@ pub mod fml2 {
     // https://wiki.vg/Minecraft_Forge_Handshake#FML2_protocol_.281.13_-_Current.29
     use super::*;
 
-    #[derive(Clone, Default, Debug)]
+    #[derive(Clone, Default, Debug, PartialEq, Eq)]
     pub struct Channel {
         pub name: String,
         pub version: String,
@@ -216,7 +216,7 @@ pub mod fml2 {
         }
     }
 
-    #[derive(Clone, Default, Debug)]
+    #[derive(Clone, Default, Debug, PartialEq, Eq)]
     pub struct Registry {
         pub name: String,
         pub marker: String,
@@ -236,7 +236,7 @@ pub mod fml2 {
         }
     }
 
-    #[derive(Debug)]
+    #[derive(Debug, Clone, PartialEq, Eq)]
     pub enum FmlHandshake {
         ModList {
             mod_names: LenPrefixed<VarInt, String>,

diff --git a/protocol/src/protocol/mod.rs b/protocol/src/protocol/mod.rs
@@ -75,7 +75,7 @@ macro_rules! state_packets {
         use crate::protocol::*;
         use std::io;
 
-        #[derive(Debug)]
+        #[derive(Debug, Clone, PartialEq)]
         pub enum Packet {
         $(
             $(
@@ -107,7 +107,7 @@ macro_rules! state_packets {
                 }
 
                 $(
-                    #[derive(Default, Debug)]
+                    #[derive(Default, Debug, Clone, PartialEq)]
                     $(#[$attr])* pub struct $name {
                         $($(#[$fattr])* pub $field: $field_type),+,
                     }
@@ -418,7 +418,7 @@ impl Serializable for f64 {
 #[derive(Debug, PartialEq, Eq, Hash, Clone)]
 pub struct UUID(u64, u64);
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct UUIDParseError;
 impl std::error::Error for UUIDParseError {}
 
@@ -469,6 +469,7 @@ impl Serializable for UUID {
     }
 }
 
+#[derive(Clone, PartialEq, Eq)]
 pub struct Biomes3D {
     pub data: [i32; 1024],
 }
@@ -511,6 +512,7 @@ pub trait Lengthable: Serializable + Copy + Default {
     fn from_len(_: usize) -> Self;
 }
 
+#[derive(Clone, PartialEq, Eq)]
 pub struct LenPrefixed<L: Lengthable, V> {
     len: L,
     pub data: Vec<V>,
@@ -566,6 +568,7 @@ impl<L: Lengthable, V: fmt::Debug> fmt::Debug for LenPrefixed<L, V> {
 }
 
 // Optimization
+#[derive(Clone, PartialEq, Eq)]
 pub struct LenPrefixedBytes<L: Lengthable> {
     len: L,
     pub data: Vec<u8>,
@@ -662,7 +665,7 @@ impl Lengthable for i32 {
 use num_traits::cast::{cast, NumCast};
 /// `FixedPoint5` has the 5 least-significant bits for the fractional
 /// part, upper for integer part: https://wiki.vg/Data_types#Fixed-point_numbers
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq, Eq)]
 pub struct FixedPoint5<T>(T);
 
 impl<T: Serializable> Serializable for FixedPoint5<T> {
@@ -708,7 +711,7 @@ where
 }
 
 /// `FixedPoint12` is like `FixedPoint5` but the fractional part is 12-bit
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq, Eq)]
 pub struct FixedPoint12<T>(T);
 
 impl<T: Serializable> Serializable for FixedPoint12<T> {
@@ -755,7 +758,7 @@ where
 
 /// `VarInt` have a variable size (between 1 and 5 bytes) when encoded based
 /// on the size of the number
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 pub struct VarInt(pub i32);
 
 impl Lengthable for VarInt {
@@ -818,7 +821,7 @@ impl fmt::Debug for VarInt {
 
 /// `VarShort` have a variable size (2 or 3 bytes) and are backwards-compatible
 /// with vanilla shorts, used for Forge custom payloads
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq, Eq)]
 pub struct VarShort(pub i32);
 
 impl Lengthable for VarShort {
@@ -881,7 +884,7 @@ impl fmt::Debug for VarShort {
 
 /// `VarLong` have a variable size (between 1 and 10 bytes) when encoded based
 /// on the size of the number
-#[derive(Clone, Copy)]
+#[derive(Clone, Copy, PartialEq, Eq)]
 pub struct VarLong(pub i64);
 
 impl Lengthable for VarLong {
@@ -963,7 +966,7 @@ impl Serializable for Position {
 
 /// Direction is used to define whether packets are going to the
 /// server or the client.
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum Direction {
     Serverbound,
     Clientbound,
@@ -1436,7 +1439,7 @@ pub fn try_parse_packet(ibuf: Vec<u8>, protocol_version: i32) {
     }
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Status {
     pub version: StatusVersion,
     pub players: StatusPlayers,
@@ -1446,20 +1449,20 @@ pub struct Status {
     pub fml_network_version: Option<i64>,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct StatusVersion {
     pub name: String,
     pub protocol: i32,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct StatusPlayers {
     pub max: i32,
     pub online: i32,
     pub sample: Vec<StatusPlayer>,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub struct StatusPlayer {
     name: String,
     id: String,

diff --git a/protocol/src/protocol/mojang.rs b/protocol/src/protocol/mojang.rs
@@ -16,7 +16,7 @@
 use serde_json::json;
 use sha1::{self, Digest};
 
-#[derive(Clone, Debug)]
+#[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Profile {
     pub username: String,
     pub id: String,