Struct GbpFrame 

pub struct GbpFrame {
    pub version: u8,
    pub group_id: ByteBuf,
    pub epoch: u64,
    pub transition_id: u32,
    pub stream_type: u8,
    pub stream_id: u32,
    pub flags: u16,
    pub sequence_no: u32,
    pub payload_size: u32,
    pub encrypted_payload: ByteBuf,
    pub payload_format: u8,
}

CBOR-encoded GBP frame.

Fields

version: u8

Protocol version (currently 1).

group_id: ByteBuf

16-byte group identifier.

epoch: u64

Sender’s current epoch.

transition_id: u32

Last applied transition_id.

stream_type: u8

StreamType as a u8 (see gbp_core::StreamType).

stream_id: u32

Logical stream identifier within the session.

flags: u16

Delivery flags (see gbp_core::GbpFlags).

sequence_no: u32

Per-stream sequence number (replay window key).

payload_size: u32

Declared payload length; MUST equal encrypted_payload.len().

encrypted_payload: ByteBuf

Encrypted payload (an opaque byte string).

payload_format: u8

Payload codec discriminant (see gbp_core::PayloadCodec). Omitted when 0 (CBOR) for backward-compatibility with pre-1.5 peers.

Implementations

impl GbpFrame

pub fn new( group_id: [u8; 16], epoch: u64, transition_id: u32, stream_type: StreamType, stream_id: u32, flags: u16, sequence_no: u32, encrypted_payload: Vec<u8>, payload_format: u8, ) -> GbpFrame

Builds a frame from already-encrypted payload bytes.

payload_size is set to encrypted_payload.len() automatically. Pass PayloadCodec::Cbor (or 0) for the default CBOR encoding; the pf field is omitted from the wire when the codec is CBOR so older peers continue to decode the frame correctly.

pub fn payload_codec(&self) -> PayloadCodec

Returns the payload_format field as a PayloadCodec, falling back to PayloadCodec::Cbor for unknown discriminants.

pub fn to_cbor(&self) -> Vec<u8>

Serialises the frame into a freshly allocated CBOR byte vector.

pub fn from_cbor(data: &[u8]) -> Result<GbpFrame, CodecError>

Decodes a CBOR-encoded frame and validates payload_size.

The order of all §6.2 checks (version, group_id, epoch, payload_size, transition_id, sequence_no) is what governs which error a malformed frame produces. Most callers should use GroupNode::on_wire which decodes via GbpFrame::decode and runs the full pipeline. This convenience wrapper exists for tests and ad-hoc tooling that want both decode and the length check in one shot.

pub fn decode(data: &[u8]) -> Result<GbpFrame, CodecError>

Decodes a CBOR-encoded frame without running any §6.2 checks.

Use GbpFrame::validate_payload_size (and the higher-priority version / group_id / epoch checks at the calling layer) before trusting the result.

pub fn validate_payload_size(&self) -> Result<(), CodecError>

Returns Ok(()) if payload_size equals the actual payload length, Err(CodecError::PayloadSizeMismatch) otherwise.

pub fn stream_type_typed(&self) -> Result<StreamType, CodecError>

Returns the typed StreamType, or CodecError::UnknownEnumValue for unknown stream classes.

pub fn group_id_array(&self) -> [u8; 16]

Returns group_id as a 16-byte array, padding with zeros or truncating if necessary.

Trait Implementations

impl Clone for GbpFrame

fn clone(&self) -> GbpFrame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GbpFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GbpFrame

fn deserialize<__D>( __deserializer: __D, ) -> Result<GbpFrame, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GbpFrame

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.