pub enum Datagram {
Payload(DatagramHeader),
Status(DatagramStatusHeader),
}Expand description
One datagram, of whichever shape its type field names.
A MoQT datagram opens with a variable-length integer naming its type, and
that integer is what says which of the layouts above follows it.
Neither DatagramHeader nor DatagramStatusHeader reads or writes it, so neither can be handed
the first byte of a datagram a peer sent, and neither produces bytes a peer
can read. This is the entry point that does both.
The payload of a payload-bearing datagram runs to the end of the QUIC
datagram, so it is not part of this value: Self::decode stops at the end
of the header and leaves the payload in the buffer, and a caller appends the
payload after Self::encode.
Variants§
Payload(DatagramHeader)
An object carrying a payload.
Status(DatagramStatusHeader)
An object stating a status, with no payload.
Implementations§
Source§impl Datagram
impl Datagram
Sourcepub fn is_status(&self) -> bool
pub fn is_status(&self) -> bool
Whether this datagram states an Object Status instead of carrying a payload.
Draft-08 can say it two ways: on the dedicated status message, and on the payload message with a declared payload length of zero, which draft-09 removed.
Sourcepub fn datagram_type(&self) -> StreamType
pub fn datagram_type(&self) -> StreamType
The type field this value writes.
Sourcepub fn decode(buf: &mut impl Buf) -> Result<Self, CodecError>
pub fn decode(buf: &mut impl Buf) -> Result<Self, CodecError>
Decode a datagram from its first byte, type field included.
Errors with CodecError::UnknownDatagramType when the leading type is
one the datagram table does not assign, which this draft answers with a
close, and with CodecError::InvalidField for the stream types, which
it does assign but not to a datagram. datagram_type_error draws that
line.
Sourcepub fn encode_checked(&self, buf: &mut impl BufMut) -> Result<(), CodecError>
pub fn encode_checked(&self, buf: &mut impl BufMut) -> Result<(), CodecError>
Encode the datagram, refusing a header the framing it names cannot carry.
The body is built before anything reaches buf, so a refused datagram
leaves buf untouched rather than a type field with no body under it.