Struct SubgroupObjectMeta 

pub struct SubgroupObjectMeta {
    pub object_id: u64,
    pub extension_headers_len: u64,
    pub payload_length: u64,
    pub status: Option<u64>,
    pub wire_len: u64,
}

The framing of one subgroup object, without its payload.

Produced by SubgroupObjectReader::read_object_meta for callers that forward an object’s bytes verbatim and never inspect the payload.

Fields

object_id: u64

Resolved Object ID (delta decoded to an absolute value).

extension_headers_len: u64

Byte length of the extension-header block’s contents, excluding its length prefix.

payload_length: u64

Declared payload length. Zero when status is Some.

status: Option<u64>

Object Status wire code, present only when the payload is empty.

wire_len: u64

Total bytes this object occupies on the wire, prefix fields included.

Implementations

impl SubgroupObjectMeta

pub fn payload_permission(&self) -> Option<PayloadPermission>

Whether this object’s status permits it a non-empty payload.

The same question SubgroupObject::permits_payload answers, from the declared length and the wire code rather than from the bytes. A relay that forwards an object verbatim reads it through SubgroupObjectReader::read_object_meta and never copies the payload, so asking this must not require having it.

An absent status answers PayloadPermission::Permitted rather than None. A meta has no status only when its payload length is non-zero, so the object has a status — the encoding just does not spell it.

None means the code is one this draft leaves unassigned, and so one it gives no payload rule for. That is not reachable through SubgroupObjectReader::read_object_meta, which refuses such a code before it can reach the field, but the fields here are public and a meta assembled by hand — by a relay carrying a status across from a draft that numbers them differently, say — can hold anything a varint can. The answer there is that this draft has none, not that the payload is forbidden.

Trait Implementations

impl Clone for SubgroupObjectMeta

fn clone(&self) -> SubgroupObjectMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubgroupObjectMeta

impl Debug for SubgroupObjectMeta

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

Formats the value using the given formatter.

impl Eq for SubgroupObjectMeta

impl PartialEq for SubgroupObjectMeta

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubgroupObjectMeta