feat: Some comments

Author: Andcool-Systems

src/byte_buf_utils.rs

@@ -79,6 +79,10 @@ pub fn read_unsigned_short(buf: &mut BytesMut) -> io::Result<u16> {
     Ok(buf.get_u16())
 }
 
+/*
+For some reason, not all Minecraft clients send their UUID correctly,
+so you have to return Result, since parsing is not always possible.
+*/
 pub fn try_get_uuid(buf: &mut BytesMut) -> anyhow::Result<Uuid> {
     let len = buf.len();
     if len < 16 {

src/handlers/handshake.rs

@@ -15,6 +15,7 @@ pub async fn handle_handshake(client: &mut MinecraftClient) -> Result<()> {
         _ => NextStateEnum::Unknown,
     };
 
+    // Check client's connecting hostname
     client.session.proto_ver = Some(handshake.proto_ver);
     if let Some(server_ip) = &client.config.server.server_ip {
         if server_ip.ne(&handshake.server_addr) {

src/packets/handshake.rs

@@ -1,8 +1,7 @@
+use crate::byte_buf_utils::{read_unsigned_short, read_utf8, read_varint};
 use bytes::BytesMut;
 use tokio::io;
 
-use crate::byte_buf_utils::{read_unsigned_short, read_utf8, read_varint};
-
 #[allow(dead_code)]
 pub struct HandshakePacket {
     pub proto_ver: usize,
@@ -17,7 +16,7 @@ impl HandshakePacket {
             proto_ver: read_varint(buff)?,
             server_addr: read_utf8(buff)?,
             port: read_unsigned_short(buff)?,
-            next_state: read_varint(buff)?
+            next_state: read_varint(buff)?,
         })
     }
 }

src/packets/login_start.rs

@@ -1,8 +1,7 @@
+use crate::byte_buf_utils::{read_utf8, try_get_uuid};
 use bytes::BytesMut;
 use uuid::Uuid;
 
-use crate::byte_buf_utils::{read_utf8, try_get_uuid};
-
 pub struct LoginStartPacket {
     pub name: String,
     pub uuid: Option<Uuid>,

src/packets/ping.rs

@@ -1,12 +1,9 @@
+use crate::byte_buf_utils::{add_size, write_varint};
 use anyhow::Result;
 use bytes::{BufMut, BytesMut};
 
-use crate::byte_buf_utils::{add_size, write_varint};
-
-
-#[allow(dead_code)]
 pub struct PingPacket {
-    pub payload: i64
+    pub payload: i64,
 }
 
 impl PingPacket {

src/packets/status.rs

@@ -1,10 +1,9 @@
+use crate::byte_buf_utils::{add_size, write_utf8, write_varint};
 use anyhow::Result;
 use bytes::BytesMut;
 use serde::Serialize;
 use serde_json::Value;
 
-use crate::byte_buf_utils::{add_size, write_utf8, write_varint};
-
 pub struct StatusPacket {}
 
 impl StatusPacket {

src/responses/disconnect.rs

@@ -13,10 +13,13 @@ pub async fn send_disconnect(
     }
     .build()?;
 
+    // Passing a session object allows sending a disconnect packet with or without encryption.
     encrypt_packet(&mut disconnect_packet, session);
 
     stream.writable().await?;
     stream.write_all(&disconnect_packet).await?;
+
+    // Minecraft clients expect that after sending a disconnect packet there should be a disconnect
     stream.shutdown().await?;
 
     debug!("Disconnected client with reason: {}", reason);

src/responses/encryption.rs

@@ -1,10 +1,9 @@
+use crate::{client::Session, packets::encryption_request::EncryptionRequestPacket};
 use anyhow::Result;
 use rsa::pkcs8::EncodePublicKey;
 use std::sync::Arc;
 use tokio::{io::AsyncWriteExt, net::TcpStream};
 
-use crate::{client::Session, packets::encryption_request::EncryptionRequestPacket};
-
 pub async fn send_encryption(
     stream: &mut TcpStream,
     keys: Arc<rsa::RsaPrivateKey>,

src/responses/ping.rs

@@ -1,10 +1,9 @@
 use anyhow::Result;
 
+use crate::packets::ping::PingPacket;
 use bytes::{Buf, BytesMut};
 use tokio::{io::AsyncWriteExt, net::TcpStream};
 
-use crate::packets::ping::PingPacket;
-
 pub async fn handle_ping(stream: &mut TcpStream, buff: &mut BytesMut) -> Result<()> {
     let payload = buff.get_i64();
     let packet = PingPacket { payload };

src/responses/status.rs

@@ -1,10 +1,9 @@
 use anyhow::Result;
 
+use crate::{client::Session, config::get_config, packets::status};
 use serde_json::json;
 use tokio::{io::AsyncWriteExt, net::TcpStream};
 
-use crate::{client::Session, config::get_config, packets::status};
-
 pub async fn send_status(stream: &mut TcpStream, session: &mut Session) -> Result<()> {
     let config = get_config().await;
     let proto_ver = if config.server.config.protocol == 0 {