Struct SeqNo

pub struct SeqNo(/* private fields */);

Sequence number of an RTP packet.

An RTP packet is identified by: SSRC + SeqNo. However in the RTP header the sequence number is a u16, meaning the value quite quickly “rolls over”. To uniquely identify a packet, str0m keeps track of the roll overs and converts the u16 to u64 in this SeqNo.

To get the RTP u16 value from a SeqNo, use as_u16() or cast it to u16.

let seq_no: SeqNo = 65_537.into();

// Use `as_u16()`.
let a = seq_no.as_u16();
// Discard upper 48 bits to get RTP u16.
let b = *seq_no as u16;

assert_eq!(a, 1);
assert_eq!(b, 1);

Implementations

impl SeqNo

pub fn new() -> Self

Creates a new random id.

impl SeqNo

pub fn is_next(&self, other: SeqNo) -> bool

Check if the other sequence number is directly following this.

pub fn inc(&mut self) -> SeqNo

Increase (mutate) this sequence number and return the previous value.

pub fn as_u16(&self) -> u16

The RTP header value (discarding the ROC).

This is the same as discarding the top 48 bits by casting to a u16.

let seq_no: SeqNo = 65_537.into();

// Use `as_u16()`.
let a = seq_no.as_u16();

assert_eq!(a, 1);

pub fn roc(&self) -> u64

Get the rollover counter (ROC) value.

// More than 2^16, thus rolled over.
let seq_no: SeqNo = 95_000.into();

assert_eq!(seq_no.roc(), 1);

// Is the same as shifting 16 bits.
assert_eq!(seq_no.roc(), 95_000 >> 16);

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Clone for SeqNo

fn clone(&self) -> SeqNo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeqNo

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

Formats the value using the given formatter.

impl Deref for SeqNo

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for SeqNo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SeqNo

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

Formats the value using the given formatter.

impl From<u64> for SeqNo

fn from(v: u64) -> Self

Converts to this type from the input type.

impl Hash for SeqNo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SeqNo

fn cmp(&self, other: &SeqNo) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SeqNo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for SeqNo

fn partial_cmp(&self, other: &SeqNo) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SeqNo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SeqNo

impl Eq for SeqNo

impl StructuralPartialEq for SeqNo