wireframe 0.3.0

Simplify building servers and clients for custom binary protocols.
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

//! Unique identifier newtype used by the fragmentation layer.
//!
//! `MessageId` is a thin wrapper around `u64` so protocols can tag logical
//! messages without exposing raw integers throughout the codebase.

use bincode::{Decode, Encode};
use derive_more::{Display, From};

/// Unique identifier for a logical message undergoing fragmentation.
///
/// # Examples
///
/// ```
/// use wireframe::fragment::MessageId;
/// let id = MessageId::new(42);
/// assert_eq!(id.get(), 42);
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Encode, Decode, Display, From)]
#[display("{_0}")]
pub struct MessageId(u64);

impl MessageId {
    /// Create a new identifier.
    #[must_use]
    pub const fn new(value: u64) -> Self { Self(value) }

    /// Return the inner numeric identifier.
    #[must_use]
    pub const fn get(self) -> u64 { self.0 }
}

impl From<MessageId> for u64 {
    fn from(value: MessageId) -> Self { value.0 }
}