Change naming convention packet -> message

Author: robertwayne

README.md

@@ -63,28 +63,28 @@ use tokio_tungstenite::{accept_async, tungstenite::Message};
 
 #[derive(Encode)]
 #[repr(u16)]
-enum PacketId {
+enum MessageId {
     Join,
 }
 
 // We need to make sure we can convert our enum to a u16, as that is the type
-// bufferfish uses to identify packets. You can use the `num_enum` crate and
+// bufferfish uses to identify messages. You can use the `num_enum` crate and
 // derive `IntoPrimitive` and `FromPrimitive` to remove this step completely.
-impl From<PacketId> for u16 {
-    fn from(id: PacketId) -> u16 {
+impl From<MessageId> for u16 {
+    fn from(id: MessageId) -> u16 {
         match id {
-            PacketId::Join => 0,
+            MessageId::Join => 0,
         }
     }
 }
 
-// We annotate our packet with the #[Encode] and #[Decode] macros to enable
+// We annotate our message with the #[Encode] and #[Decode] macros to enable
 //  automatic encoding and decoding to or from a `Bufferfish`.
 //
-// Additionally, we use the #[bufferfish] attribute to specify the packet ID.
+// Additionally, we use the #[bufferfish] attribute to specify the message ID.
 #[derive(Encode)]
-#[bufferfish(PacketId::Join)]
-struct JoinPacket {
+#[bufferfish(MessageId::Join)]
+struct JoinMessage {
     id: u32
     username: String,
 }
@@ -107,11 +107,11 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
 async fn process(steam: TcpStream) -> Result<(), Box<dyn std::error::Error>> {
     let mut ws = accept_async(steam).await?;
 
-    let packet = JoinPacket {
+    let message = JoinMessage {
         id: 1,
         username: "Rob".to_string(),
     };
-    let bf = packet.to_bufferfish()?;
+    let bf = message.to_bufferfish()?;
 
     ws.send(Message::Binary(bf.into())).await?;
 
@@ -129,12 +129,12 @@ ws.binaryType = "arraybuffer"
 
 ws.onmessage = (event) => {
   const bf = new Bufferfish(event.data)
-  const packetId = bf.readUint16()
+  const messageId = bf.readUint16()
 
-    if (packetId === PacketId.Join) {
-        const packet = decodeJoinPacket(bf)
+    if (messageId === MessageId.Join) {
+        const message = decodeJoinMessage(bf)
 
-        console.log(packet) // { id: 1, username: "Rob" }
+        console.log(message) // { id: 1, username: "Rob" }
     }
 }
 ```
@@ -147,9 +147,9 @@ ws.binaryType = "arraybuffer"
 
 ws.onmessage = (event) => {
     const bf = new Bufferfish(event.data)
-    const packetId = bf.readUint16()
+    const messageId = bf.readUint16()
 
-    if (packetId === PacketId.Join) {
+    if (messageId === MessageId.Join) {
         const id = bf.readUint32()
         const username = bf.readString()
 
@@ -167,7 +167,7 @@ ws.onmessage = (event) => {
 
 ```rust
 fn main() -> Result<(), Box<dyn std::error::Error>> {
-    bufferfish::generate("src/", "../client/src/generated/Packet.ts")?;
+    bufferfish::generate("src/", "../client/src/generated/Message.ts")?;
 
     Ok(())
 }
@@ -179,50 +179,50 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 use bufferfish::Encode;
 
 #[derive(Encode)]
-pub enum PacketId {
+pub enum MessageId {
     Join = 0,
     Leave,
     Unknown = 255,
 }
 
-impl From<PacketId> for u16 {
-    fn from(id: PacketId) -> u16 {
+impl From<MessageId> for u16 {
+    fn from(id: MessageId) -> u16 {
         match id {
-            PacketId::Join => 0,
-            PacketId::Leave => 1,
-            PacketId::Unknown => 255,
+            MessageId::Join => 0,
+            MessageId::Leave => 1,
+            MessageId::Unknown => 255,
         }
     }
 }
 
 #[derive(Encode)]
-#[bufferfish(PacketId::Join)]
-pub struct JoinPacket {
+#[bufferfish(MessageId::Join)]
+pub struct JoinMessage {
     pub id: u8,
     pub username: String,
 }
 
 #[derive(Encode)]
-#[bufferfish(PacketId::Leave)]
-pub struct LeavePacket;
+#[bufferfish(MessageId::Leave)]
+pub struct LeaveMessage;
 ```
 
 ```typescript
 /* AUTOGENERATED BUFFERFISH FILE, DO NOT EDIT */
 import { Bufferfish } from 'bufferfish';
 
-export enum PacketId {
+export enum MessageId {
     Join = 0,
     Leave = 1,
     Unknown = 255,
 }
 
-export interface JoinPacket {
+export interface JoinMessage {
     id: number
     username: string
 }
 
-export const decodeJoinPacket = (bf: Bufferfish): JoinPacket => {
+export const decodeJoinMessage = (bf: Bufferfish): JoinMessage => {
     return {
         id: bf.readUint8() as number,
         username: bf.readString() as string,

rust/bufferfish-core/src/lib.rs

@@ -14,8 +14,8 @@ pub use encodable::Encodable;
 pub enum BufferfishError {
     /// std::io::Error that occurred during a write operation.
     FailedWrite(std::io::Error),
-    /// Invalid - typically non-u16 - packet ID encountered during a write.
-    InvalidPacketId,
+    /// Invalid - typically non-u16 - message ID encountered during a write.
+    InvalidMessageId,
     /// Invalid enum variant encountered during encoding/decoding.
     InvalidEnumVariant,
     /// The buffer doesn't contain enough bytes for the requested operation.
@@ -31,7 +31,7 @@ impl std::fmt::Display for BufferfishError {
     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
         match self {
             BufferfishError::FailedWrite(e) => write!(f, "failed to write to buffer: {e}"),
-            BufferfishError::InvalidPacketId => write!(f, "invalid packet id"),
+            BufferfishError::InvalidMessageId => write!(f, "invalid message id"),
             BufferfishError::InvalidEnumVariant => write!(f, "invalid enum variant"),
             BufferfishError::InsufficientBytes {
                 available,
@@ -61,7 +61,7 @@ impl std::error::Error for BufferfishError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         match self {
             BufferfishError::FailedWrite(e) => Some(e),
-            BufferfishError::InvalidPacketId => None,
+            BufferfishError::InvalidMessageId => None,
             BufferfishError::InvalidEnumVariant => None,
             BufferfishError::InsufficientBytes { .. } => None,
             BufferfishError::ExcessiveBytes { .. } => None,

rust/bufferfish-derive/src/lib.rs

@@ -13,10 +13,10 @@ pub fn bufferfish_impl_encodable(input: proc_macro::TokenStream) -> proc_macro::
     let ast = parse_macro_input!(input as DeriveInput);
     let name = &ast.ident;
 
-    let packet_id = get_packet_id(&ast);
-    let packet_id_snippet = {
-        if let Some(packet_id) = packet_id {
-            quote! { bf.write_u16(u16::from(#packet_id))?; }
+    let message_id = get_message_id(&ast);
+    let message_id_snippet = {
+        if let Some(message_id) = message_id {
+            quote! { bf.write_u16(u16::from(#message_id))?; }
         } else {
             quote! {}
         }
@@ -69,7 +69,7 @@ pub fn bufferfish_impl_encodable(input: proc_macro::TokenStream) -> proc_macro::
 
             fn encode(&self, bf: &mut bufferfish::Bufferfish) -> Result<(), bufferfish::BufferfishError>
             {
-                #packet_id_snippet
+                #message_id_snippet
                 self.encode_value(bf)
             }
         }
@@ -84,14 +84,14 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
     let ast = parse_macro_input!(input as DeriveInput);
     let name = &ast.ident;
 
-    let packet_id = get_packet_id(&ast);
-    let has_packet_id = packet_id.is_some();
-    let packet_id_snippet = {
-        if let Some(packet_id) = packet_id {
+    let message_id = get_message_id(&ast);
+    let has_message_id = message_id.is_some();
+    let message_id_snippet = {
+        if let Some(message_id) = message_id {
             quote! {
-                let packet_id = bf.read_u16()?;
-                if packet_id != u16::from(#packet_id) {
-                    return Err(bufferfish::BufferfishError::InvalidPacketId);
+                let message_id = bf.read_u16()?;
+                if message_id != u16::from(#message_id) {
+                    return Err(bufferfish::BufferfishError::InvalidMessageId);
                 }
             }
         } else {
@@ -217,7 +217,7 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                 quote! {
                     impl bufferfish::Decodable for #name {
                         fn decode(bf: &mut bufferfish::Bufferfish) -> Result<Self, bufferfish::BufferfishError> {
-                            #packet_id_snippet
+                            #message_id_snippet
                             Self::decode_value(bf)
                         }
 
@@ -228,15 +228,15 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                         }
 
                         fn min_bytes_required() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            let mut min_size = packet_id_size;
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            let mut min_size = message_id_size;
                             #(#min_size_snippets)*
                             Some(min_size)
                         }
 
                         fn max_bytes_allowed() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            let mut max_size = packet_id_size;
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            let mut max_size = message_id_size;
                             #(#max_size_snippets)*
                             Some(max_size)
                         }
@@ -247,7 +247,7 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                 quote! {
                     impl bufferfish::Decodable for #name {
                         fn decode(bf: &mut bufferfish::Bufferfish) -> Result<Self, bufferfish::BufferfishError> {
-                            #packet_id_snippet
+                            #message_id_snippet
                             Self::decode_value(bf)
                         }
 
@@ -258,15 +258,15 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                         }
 
                         fn min_bytes_required() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            let mut min_size = packet_id_size;
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            let mut min_size = message_id_size;
                             #(#min_size_snippets)*
                             Some(min_size)
                         }
 
                         fn max_bytes_allowed() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            let mut max_size = packet_id_size;
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            let mut max_size = message_id_size;
                             #(#max_size_snippets)*
                             Some(max_size)
                         }
@@ -277,7 +277,7 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                 quote! {
                     impl bufferfish::Decodable for #name {
                         fn decode(bf: &mut bufferfish::Bufferfish) -> Result<Self, bufferfish::BufferfishError> {
-                            #packet_id_snippet
+                            #message_id_snippet
                             Self::decode_value(bf)
                         }
 
@@ -286,13 +286,13 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                         }
 
                         fn min_bytes_required() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            Some(packet_id_size)
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            Some(message_id_size)
                         }
 
                         fn max_bytes_allowed() -> Option<usize> {
-                            let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                            Some(packet_id_size)
+                            let message_id_size = if #has_message_id { 2 } else { 0 };
+                            Some(message_id_size)
                         }
                     }
                 }
@@ -302,7 +302,7 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
             quote! {
                 impl bufferfish::Decodable for #name {
                     fn decode(bf: &mut bufferfish::Bufferfish) -> Result<Self, bufferfish::BufferfishError> {
-                        #packet_id_snippet
+                        #message_id_snippet
                         Self::decode_value(bf)
                     }
 
@@ -315,15 +315,15 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
                     }
 
                     fn min_bytes_required() -> Option<usize> {
-                        // Enum variant (u8) + packet id if present
-                        let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                        Some(1 + packet_id_size) // 1 byte for variant + packet id size if present
+                        // Enum variant (u8) + message id if present
+                        let message_id_size = if #has_message_id { 2 } else { 0 };
+                        Some(1 + message_id_size) // 1 byte for variant + message id size if present
                     }
 
                     fn max_bytes_allowed() -> Option<usize> {
-                        // Enum variant (u8) + packet id if present
-                        let packet_id_size = if #has_packet_id { 2 } else { 0 };
-                        Some(1 + packet_id_size) // 1 byte for variant + packet id size if present
+                        // Enum variant (u8) + message id if present
+                        let message_id_size = if #has_message_id { 2 } else { 0 };
+                        Some(1 + message_id_size) // 1 byte for variant + message id size if present
                     }
                 }
             }
@@ -334,7 +334,7 @@ pub fn bufferfish_impl_decodable(input: proc_macro::TokenStream) -> proc_macro::
     generated.into()
 }
 
-fn get_packet_id(ast: &DeriveInput) -> Option<Expr> {
+fn get_message_id(ast: &DeriveInput) -> Option<Expr> {
     for attr in &ast.attrs {
         if attr.path().is_ident("bufferfish") {
             if let Ok(expr) = attr.parse_args::<syn::Expr>() {