minechat-protocol 0.3.0

The MineChat protocol, enabling you chat with people over on Minecraft
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use log::error;
use miette::Diagnostic;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use tokio::io;

/// Errors that can occur during the operation of the MineChat protocol.
#[derive(Debug, Error, Diagnostic)]
pub enum MineChatError {
    /// I/O error. Contains the underlying error.
    #[error("I/O error: {0}")]
    #[diagnostic(code(minechat::io))]
    Io(#[from] io::Error),

    /// Serde error. Contains the underlying JSON error.
    #[error("Serde error: {0}")]
    #[diagnostic(code(minechat::serde))]
    Serde(#[from] serde_json::Error),

    /// Server not linked.
    #[error("Server not linked")]
    ServerNotLinked,

    /// Configuration error.
    #[error("Config error: {0}")]
    #[diagnostic(code(minechat::config_error), help = "Check your configuration file")]
    ConfigError(String),

    /// Authentication failed.
    #[error("Authentication failed: {0}")]
    #[diagnostic(
        code(minechat::auth_failed),
        help = "Try logging in again with valid credentials"
    )]
    AuthFailed(String),

    /// UUID error.
    #[error("UUID error: {0}")]
    #[diagnostic(code(minechat::uuid))]
    Uuid(#[from] uuid::Error),

    /// Disconnected.
    #[error("Disconnected")]
    #[diagnostic(
        code(minechat::disconnected),
        help = "If this is unexpected, try reconnecting"
    )]
    Disconnected,
}

/// The different types of messages that can be sent and received in the MineChat protocol.
#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum MineChatMessage {
    /// An authentication message, containing the client's UUID and link code.
    #[serde(rename = "AUTH")]
    Auth { payload: AuthPayload },

    /// An acknowledgment of a successful authentication, containing the server's response.
    #[serde(rename = "AUTH_ACK")]
    AuthAck { payload: AuthAckPayload },

    /// A chat message, containing the message text.
    #[serde(rename = "CHAT")]
    Chat { payload: ChatPayload },

    /// A broadcast message, containing the message text and the sender's name.
    #[serde(rename = "BROADCAST")]
    Broadcast { payload: BroadcastPayload },

    /// A disconnect message, containing the reason for the disconnection.
    #[serde(rename = "DISCONNECT")]
    Disconnect { payload: DisconnectPayload },
}

/// The payload for an authentication message.
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthPayload {
    /// The client's UUID.
    pub client_uuid: String,
    /// The link code used to authenticate with the server.
    pub link_code: String,
}

/// The payload for an authentication acknowledgment message.
#[derive(Debug, Serialize, Deserialize)]
pub struct AuthAckPayload {
    /// The status of the authentication (either "success" or "failure").
    pub status: String,
    /// A message describing the authentication status.
    pub message: String,
    /// The client's Minecraft UUID, if available.
    pub minecraft_uuid: Option<String>,
    /// The client's Minecraft username, if available.
    pub username: Option<String>,
}

/// The payload for a chat message.
#[derive(Debug, Serialize, Deserialize)]
pub struct ChatPayload {
    /// The text of the chat message.
    pub message: String,
}

/// The payload for a broadcast message.
#[derive(Debug, Serialize, Deserialize)]
pub struct BroadcastPayload {
    /// The name of the sender.
    pub from: String,
    /// The text of the broadcast message.
    pub message: String,
}

/// The payload for a disconnect message.
#[derive(Debug, Serialize, Deserialize)]
pub struct DisconnectPayload {
    /// The reason for the disconnection.
    pub reason: String,
}