Struct ObjectHeader 

pub struct ObjectHeader {
    pub object_id: VarInt,
    pub extension_headers_length: VarInt,
    pub extensions: Vec<u8>,
    pub payload_length: VarInt,
    pub object_status: ObjectStatus,
}

Object within a subgroup stream (draft-09).

Encoding: object_id(vi), extension_headers_length(vi), [extensions…], payload_length(vi), if payload_length == 0: object_status(vi) else: payload bytes

Fields

object_id: VarInt

Object identifier within the subgroup.

extension_headers_length: VarInt

Total byte length of extension headers, as it arrived.

Advisory on encode. Every encoder here writes VarInt::from_usize(self.extensions.len()) and never reads this field, so a hand-built header whose stated length disagrees with the bytes beside it goes on the wire with the derived length and is read back consistent. Decoding always sets the two together, so a value that came off the wire never disagrees.

It is kept because it is what the peer stated, which is not always recoverable from the bytes: a non-minimal varint length encodes the same number in more bytes, and a relay that must forward the block unchanged has to know which it saw.

extensions: Vec<u8>

Raw extension bytes (opaque).

payload_length: VarInt

Length of the object payload in bytes.

object_status: ObjectStatus

Status of this object.

Implementations

impl ObjectHeader

pub fn encode(&self, buf: &mut impl BufMut)

Encode the object header into the buffer.

pub fn encode_checked(&self, buf: &mut impl BufMut) -> Result<(), CodecError>

Encode the header, refusing a status the framing cannot carry.

Section 8.4.1 puts the Object Status field on the wire only when the Object Payload Length is zero, and Section 8.1.1.1 says “Any object with a status code other than zero MUST have an empty payload”. A non-zero status paired with a non-zero payload length therefore has no encoding at all: Self::encode drops the status and the peer reads an ordinary object, which is a different object from the one the caller described. This refuses instead.

The datagram types on this draft already refuse the same pairing. These two did not, and they are the ones a publisher writes on every stream.

Errors

CodecError::InvalidField if a non-zero Object Status is paired with a non-zero Object Payload Length.

pub fn decode(buf: &mut impl Buf) -> Result<Self, CodecError>

Decode an object header from the buffer.

Trait Implementations

impl Clone for ObjectHeader

fn clone(&self) -> ObjectHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectHeader

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

Formats the value using the given formatter.

impl Eq for ObjectHeader

impl PartialEq for ObjectHeader

fn eq(&self, other: &ObjectHeader) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ObjectHeader