reovim-protocol 0.14.4

Wire protocol types for reovim client-server communication
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

//! Connection health event types for RPC protocol.
//!
//! Ping/pong events for connection health monitoring.

use serde::{Deserialize, Serialize};

/// Ping event (serializable).
///
/// Sent by either client or server to check connection health.
/// The receiver should respond with a matching [`PongEvent`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PingEvent {
    /// Optional sequence number for matching ping/pong pairs.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seq: Option<u64>,
    /// Optional timestamp (milliseconds since epoch).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<u64>,
}

impl PingEvent {
    /// Create a new ping event without sequence.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            seq: None,
            timestamp: None,
        }
    }

    /// Create a ping event with sequence number.
    #[must_use]
    pub const fn with_seq(seq: u64) -> Self {
        Self {
            seq: Some(seq),
            timestamp: None,
        }
    }

    /// Create a ping event with timestamp.
    #[must_use]
    pub const fn with_timestamp(timestamp: u64) -> Self {
        Self {
            seq: None,
            timestamp: Some(timestamp),
        }
    }
}

impl Default for PingEvent {
    fn default() -> Self {
        Self::new()
    }
}

/// Pong event (serializable).
///
/// Response to a [`PingEvent`]. Should echo the same sequence number
/// if one was provided in the ping.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PongEvent {
    /// Sequence number echoed from the ping.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub seq: Option<u64>,
    /// Original timestamp from the ping.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<u64>,
}

impl PongEvent {
    /// Create a new pong event without sequence.
    #[must_use]
    pub const fn new() -> Self {
        Self {
            seq: None,
            timestamp: None,
        }
    }

    /// Create a pong event with sequence number.
    #[must_use]
    pub const fn with_seq(seq: u64) -> Self {
        Self {
            seq: Some(seq),
            timestamp: None,
        }
    }

    /// Create a pong from a ping (echoes seq and timestamp).
    #[must_use]
    pub const fn from_ping(ping: &PingEvent) -> Self {
        Self {
            seq: ping.seq,
            timestamp: ping.timestamp,
        }
    }
}

impl Default for PongEvent {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
#[path = "health_tests.rs"]
mod tests;