Struct Pid 

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

A 13-bit MPEG-TS Packet Identifier.

Thin newtype over the wire u16. Values are masked to 13 bits on construction (0x0000..=0x1FFF), matching the transport header field width (ISO/IEC 13818-1 §2.4.3.2).

Implementations

impl Pid

pub const MASK: u16 = 0x1FFF

Mask covering the 13 valid PID bits.

pub const fn new(value: u16) -> Self

Construct a Pid, masking to the low 13 bits.

pub const fn from_wire_masked(value: u16) -> Self

Construct a Pid from the low 13 bits of value, deliberately discarding the rest: the explicit name for extracting the 13-bit PID field out of a wider wire word (e.g. reserved(3) + PID(13)), where masking is the specified behaviour. Identical to Pid::new; prefer this at parse sites so the intent is visible and a caller-supplied value is never masked by accident (use Pid::try_new for those).

use mpeg_ts::pid::Pid;
// reserved(3) = 0b111 followed by PID 0x0100.
assert_eq!(Pid::from_wire_masked(0xE100).value(), 0x0100);
assert_eq!(Pid::try_new(0xE100).unwrap_err().value, 0xE100);

pub const fn try_new(value: u16) -> Result<Self, PidOutOfRange>

Construct a Pid, rejecting any value above Pid::MASK (0x1FFF).

Use this at API boundaries that take a caller-supplied value; use Pid::new only where the bits are already masked by the wire format.

Errors

PidOutOfRange when value > 0x1FFF.

pub const fn value(self) -> u16

The raw 13-bit value.

Trait Implementations

impl Clone for Pid

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Pid

impl Debug for Pid

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

Formats the value using the given formatter.

impl Display for Pid

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

Formats the value using the given formatter.

impl Eq for Pid

impl From<Pid> for u16

fn from(pid: Pid) -> Self

Converts to this type from the input type.

impl Hash for Pid

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 LowerHex for Pid

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

Formats the value using the given formatter.

impl Ord for Pid

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Pid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Pid

fn partial_cmp(&self, other: &Self) -> 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 Pid

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Pid

impl TryFrom<u16> for Pid

type Error = PidOutOfRange

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for Pid

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

Formats the value using the given formatter.