Skip to main content

ControlPacket

Enum ControlPacket 

Source
#[non_exhaustive]
pub enum ControlPacket<'a> { Handshake(HandshakePacket<'a>), KeepAlive(KeepAlivePacket), Ack(AckPacket), Nak(NakPacket<'a>), CongestionWarning(CongestionWarningPacket), Shutdown(ShutdownPacket), AckAck(AckAckPacket), DropReq(DropReqPacket), PeerError(PeerErrorPacket), UserDefined(UserDefinedPacket<'a>), }
Expand description

An SRT control packet (draft-sharabayko-srt-01 §3.2).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Handshake(HandshakePacket<'a>)

Handshake (§3.2.1).

§

KeepAlive(KeepAlivePacket)

Keep-Alive (§3.2.3).

§

Ack(AckPacket)

ACK (§3.2.4).

§

Nak(NakPacket<'a>)

NAK / Loss Report (§3.2.5).

§

CongestionWarning(CongestionWarningPacket)

Congestion Warning (§3.2.6).

§

Shutdown(ShutdownPacket)

Shutdown (§3.2.7).

§

AckAck(AckAckPacket)

ACKACK (§3.2.8).

§

DropReq(DropReqPacket)

Message Drop Request (§3.2.9).

§

PeerError(PeerErrorPacket)

Peer Error (§3.2.10).

§

UserDefined(UserDefinedPacket<'a>)

User-Defined Type, or a Control Type Table 1 does not define.

Implementations§

Source§

impl<'a> ControlPacket<'a>

Source

pub fn parse(bytes: &'a [u8]) -> Result<Self>

Parse a control packet from bytes (the full SRT packet).

§Errors

Error::BufferTooShort if shorter than the 16-byte header; Error::WrongPacketKind if the F bit is clear (this is a data packet); type-specific errors from the dispatched CIF parser.

Source

pub fn control_type(&self) -> ControlType

The Control Type this packet carries.

Source

pub fn serialized_len(&self) -> usize

Number of bytes Self::serialize_into will write.

Source

pub fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serialize this control packet into buf.

Trait Implementations§

Source§

impl<'a> Clone for ControlPacket<'a>

Source§

fn clone(&self) -> ControlPacket<'a>

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<'a> Debug for ControlPacket<'a>

Source§

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

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

impl<'a> PartialEq for ControlPacket<'a>

Source§

fn eq(&self, other: &ControlPacket<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> Serialize for ControlPacket<'a>

Available on crate feature serde only.
Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<'a> StructuralPartialEq for ControlPacket<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ControlPacket<'a>

§

impl<'a> RefUnwindSafe for ControlPacket<'a>

§

impl<'a> Send for ControlPacket<'a>

§

impl<'a> Sync for ControlPacket<'a>

§

impl<'a> Unpin for ControlPacket<'a>

§

impl<'a> UnsafeUnpin for ControlPacket<'a>

§

impl<'a> UnwindSafe for ControlPacket<'a>

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> Same for T

Source§

type Output = T

Should always be Self
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.