Skip to main content

DatagramHeader

Struct DatagramHeader 

Source
pub struct DatagramHeader {
    pub datagram_type: u8,
    pub track_alias: VarInt,
    pub group_id: VarInt,
    pub object_id: VarInt,
    pub publisher_priority: u8,
    pub extension_headers: Vec<u8>,
    pub object_status: Option<VarInt>,
}
Expand description

Datagram header for draft-15.

The datagram_type byte encodes flags:

  • 0x02: end-of-group
  • 0x04: no object_id (object_id = 0 implied)
  • 0x20: status datagram (carries object_status instead of payload)

Fields§

§datagram_type: u8

Raw datagram-type byte encoding flags + kind.

§track_alias: VarInt

Track alias identifying the track.

§group_id: VarInt

Group ID for the contained object.

§object_id: VarInt

Object ID (zero when the no-object-id flag is set).

§publisher_priority: u8

Publisher priority.

§extension_headers: Vec<u8>

Opaque extension-headers blob (only when the 0x01 flag is set).

§object_status: Option<VarInt>

Object status (only when the 0x20 status flag is set).

Implementations§

Source§

impl DatagramHeader

Source

pub fn has_object_id(&self) -> bool

Whether the datagram carries an explicit object_id.

Source

pub fn is_end_of_group(&self) -> bool

Whether this datagram marks the end of its group.

Source

pub fn is_status(&self) -> bool

Whether this datagram carries an object_status instead of payload.

Source

pub fn has_extensions(&self) -> bool

Whether this datagram carries extension headers.

Source

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

Encode the datagram header to buf.

Source

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

Decode a datagram header from buf.

Trait Implementations§

Source§

impl Clone for DatagramHeader

Source§

fn clone(&self) -> DatagramHeader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DatagramHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DatagramHeader

Source§

impl PartialEq for DatagramHeader

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DatagramHeader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.