gbp-core 1.8.1

Core type vocabulary for the Group Broadcast Protocol stack: stream classes, frame flags, FSM states, opcodes and the error code registry.
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

//! Payload codec discriminant.

use core::fmt;

/// Codec used to encode the sub-protocol payload inside a `GbpFrame`.
///
/// The `pf` (payload_format) field in the frame header carries this value.
/// `Cbor` (0) is the default and is backward-compatible with all existing
/// implementations; frames that omit the `pf` field are treated as CBOR.
#[repr(u8)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub enum PayloadCodec {
    /// CBOR (RFC 7049) — default and backward-compatible.
    #[default]
    Cbor = 0,
    /// Protocol Buffers (proto3).
    Protobuf = 1,
    /// FlatBuffers.
    FlatBuffers = 2,
}

impl PayloadCodec {
    /// Returns the on-wire byte discriminant.
    pub const fn as_u8(self) -> u8 {
        self as u8
    }

    /// Converts from the on-wire discriminant. Returns `None` for unknown values.
    pub fn from_u8(v: u8) -> Option<Self> {
        match v {
            0 => Some(Self::Cbor),
            1 => Some(Self::Protobuf),
            2 => Some(Self::FlatBuffers),
            _ => None,
        }
    }
}

impl fmt::Display for PayloadCodec {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Cbor => "cbor",
            Self::Protobuf => "protobuf",
            Self::FlatBuffers => "flatbuffers",
        })
    }
}