Struct rtp_rs::Seq

pub struct Seq(_);

16 bit RTP sequence number value, as obtained from the sequence_number() method of RtpReader.

use rtp_rs::*;
let seq = Seq::from(123);

This type’s behavior attempts to honour the expected wrap-around of sequence number values from 0xffff back to 0x0000.

You can perform logic over sequences of RTP packets using this type and other helpers from this crate,

let start = Seq::from(0xfffe);
let end = Seq::from(0x0002);
// produces the Seq values 0xfffe, 0xffff, 0x0000, 0x0001:
for seq in (start..end).seq_iter() {
    // ...inspect some RTP packet you've stored against this sequence number...
}

Unsoundness

Note this type has implementations of Ord and PartialOrd, but those implementations violate the requirement for transitivity which both traits document.

let a = Seq::from(0);
let b = a + 0x7fff;
let c = b + 0x7fff;
assert!(a < b);
assert!(b < c);
assert!(a < c);  // Assertion fails, in violation of Ord/PartialOrd requirements

A future release will potentially deprecate Ord / PartialOrd implementations for Seq, and hopefully provide a mechanism for sequence number processing which is sound.

Implementations

impl Seq

pub fn next(self) -> Seq

Produce the sequence value which follows this one.

Sequence numbers wrap back to 0x0000 after reaching the value 0xffff

pub fn precedes(self, other: Seq) -> bool

Returns true if this sequence number value is immediately before the given one

Trait Implementations

impl Add<u16> for Seq

type Output = Seq

The resulting type after applying the + operator.

fn add(self, rhs: u16) -> Self::Output

Performs the + operation.

impl Clone for Seq

fn clone(&self) -> Seq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Seq

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

Formats the value using the given formatter.

impl From<u16> for Seq

fn from(v: u16) -> Self

Performs the conversion.

impl Ord for Seq

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Seq> for Seq

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Seq> for Seq

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl Sub<Seq> for Seq

Implements wrapped subtraction such that for instance Seq(0x0000) - Seq(0xffff) results in 1 (rather than -65535).

This is for symmetry with addition, where for example Seq(0xffff) + 1 gives Seq(0x0000)

type Output = i32

The resulting type after applying the - operator.

fn sub(self, rhs: Seq) -> Self::Output

Performs the - operation.

impl Copy for Seq

impl Eq for Seq

impl StructuralEq for Seq

impl StructuralPartialEq for Seq