naia-server 0.25.0

A server that uses either UDP or WebRTC communication to send/receive messages to/from connected clients, and syncs registered Entities/Components to clients to whom they are in-scope.
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

use std::{error::Error, fmt, net::SocketAddr};

/// Errors that can be returned by the naia server.
///
/// Returned by methods such as [`Server::send_message`] and the
/// packet-processing loop when an unrecoverable transport or protocol
/// condition is encountered.
///
/// [`Server::send_message`]: crate::Server::send_message
#[derive(Debug)]
pub enum NaiaServerError {
    /// A general descriptive error message.
    Message(String),
    /// An error from an underlying layer, boxed for type erasure.
    Wrapped(Box<dyn Error>),
    /// A packet could not be delivered to the given address.
    SendError(SocketAddr),
    /// A packet could not be read from the socket.
    RecvError,
    /// The supplied [`UserKey`] does not correspond to a currently connected
    /// user.
    ///
    /// [`UserKey`]: crate::UserKey
    UserNotFound,
    /// The target channel's send queue is at capacity. The message was not
    /// queued. The caller may retry on the next tick or discard the message.
    /// Configure [`ReliableSettings::max_queue_depth`] to adjust the limit.
    MessageQueueFull,
}

impl NaiaServerError {
    /// Constructs a [`NaiaServerError::Message`] variant from a string slice.
    pub fn from_message(message: &str) -> Self {
        Self::Message(message.to_string())
    }
}

impl fmt::Display for NaiaServerError {
    fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        match self {
            NaiaServerError::Message(msg) => write!(f, "Naia Server Error: {}", msg),
            NaiaServerError::Wrapped(boxed_err) => fmt::Display::fmt(boxed_err.as_ref(), f),
            NaiaServerError::SendError(address) => {
                write!(f, "Naia Server Error: SendError: {}", address)
            }
            NaiaServerError::RecvError => {
                write!(f, "Naia Server Error: RecvError")
            }
            NaiaServerError::UserNotFound => {
                write!(f, "Naia Server Error: UserNotFound")
            }
            NaiaServerError::MessageQueueFull => {
                write!(f, "Naia Server Error: MessageQueueFull")
            }
        }
    }
}

impl Error for NaiaServerError {}
// Safety: NaiaServerError::Wrapped contains Box<dyn Error> which is !Send by default because
// the error object may not be Send. We assert Send here because naia's internal usage of the
// Wrapped variant only stores errors produced by transport layers that are themselves Send.
// Callers who construct Wrapped with a !Send error type violate this invariant.
unsafe impl Send for NaiaServerError {}
// Safety: Same reasoning as Send above — the contained error object must also be Sync.
unsafe impl Sync for NaiaServerError {}