Struct Timescale 

pub struct Timescale<const SCALE: u64>(/* private fields */);

A timestamp representing the presentation time in a given scale. ex. 1000 for milliseconds.

All timestamps within a track are relative, so zero for one track is not zero for another. Values are constrained to fit within a QUIC VarInt (2^62) so they can be encoded and decoded easily.

This is std::time::Instant and std::time::Duration merged into one type for simplicity.

Implementations

impl<const SCALE: u64> Timescale<SCALE>

pub const MAX: Self

The maximum representable instant.

pub const ZERO: Self

The minimum representable instant.

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

Construct a timestamp directly from a value in this scale’s units. Infallible because any u32 fits within the 62-bit varint range.

pub const fn new_u64(value: u64) -> Result<Self, TimeOverflow>

Construct a timestamp directly from a value in this scale’s units. Returns TimeOverflow if value exceeds the 62-bit varint range.

pub const fn from_secs(seconds: u64) -> Result<Self, TimeOverflow>

Convert a number of seconds to a timestamp, returning an error if the timestamp would overflow.

pub const fn from_secs_unchecked(seconds: u64) -> Self

Like Self::from_secs but panics on overflow. Intended for const initializers where overflow indicates a bug, not a runtime condition.

pub const fn from_millis(millis: u64) -> Result<Self, TimeOverflow>

Convert a number of milliseconds to a timestamp, returning an error if the timestamp would overflow.

pub const fn from_millis_unchecked(millis: u64) -> Self

Like Self::from_millis but panics on overflow.

pub const fn from_micros(micros: u64) -> Result<Self, TimeOverflow>

Convert a number of microseconds to a timestamp, returning an error on overflow.

pub const fn from_micros_unchecked(micros: u64) -> Self

Like Self::from_micros but panics on overflow.

pub const fn from_nanos(nanos: u64) -> Result<Self, TimeOverflow>

Convert a number of nanoseconds to a timestamp, returning an error on overflow.

pub const fn from_nanos_unchecked(nanos: u64) -> Self

Like Self::from_nanos but panics on overflow.

pub const fn from_scale(value: u64, scale: u64) -> Result<Self, TimeOverflow>

Construct from value measured at the given scale (units per second), rescaling to SCALE. Returns TimeOverflow if the rescaled value exceeds 2^62.

pub const fn from_scale_u128( value: u128, scale: u64, ) -> Result<Self, TimeOverflow>

Like Self::from_scale but accepts a u128 source value.

pub const fn from_scale_unchecked(value: u64, scale: u64) -> Self

Like Self::from_scale but panics on overflow.

pub const fn as_secs(self) -> u64

Get the timestamp as seconds.

pub const fn as_millis(self) -> u128

Get the timestamp as milliseconds.

pub const fn as_micros(self) -> u128

Get the timestamp as microseconds.

pub const fn as_nanos(self) -> u128

Get the timestamp as nanoseconds.

pub const fn as_scale(self, scale: u64) -> u128

Convert this timestamp to the given scale (units per second).

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

Get the maximum of two timestamps.

pub const fn checked_add(self, rhs: Self) -> Result<Self, TimeOverflow>

Add two timestamps, returning TimeOverflow if the sum exceeds 2^62.

pub const fn checked_sub(self, rhs: Self) -> Result<Self, TimeOverflow>

Subtract rhs from self, returning TimeOverflow if rhs > self.

pub const fn is_zero(self) -> bool

Whether this timestamp is Self::ZERO.

pub fn now() -> Self

Current time as a timestamp, derived from tokio::time::Instant::now so it honors tokio::time::pause in tests.

pub const fn convert<const NEW_SCALE: u64>( self, ) -> Result<Timescale<NEW_SCALE>, TimeOverflow>

Convert this timestamp to a different scale.

This allows converting between different TimeScale types, for example from milliseconds to microseconds. Note that converting to a coarser scale may lose precision due to integer division.

pub fn encode<W: BufMut>(&self, w: &mut W) -> Result<(), EncodeError>

Encode this timestamp as a QUIC varint. Version-independent.

pub fn decode<R: Buf>(r: &mut R) -> Result<Self, Error>

Decode a timestamp from a QUIC varint. Version-independent.

Trait Implementations

impl<const SCALE: u64> Add for Timescale<SCALE>

type Output = Timescale<SCALE>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const SCALE: u64> AddAssign for Timescale<SCALE>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<const SCALE: u64> Clone for Timescale<SCALE>

fn clone(&self) -> Timescale<SCALE>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const SCALE: u64> Debug for Timescale<SCALE>

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

Formats the value using the given formatter.

impl<const SCALE: u64> Default for Timescale<SCALE>

fn default() -> Timescale<SCALE>

Returns the “default value” for a type.

impl<const SCALE: u64> From<Instant> for Timescale<SCALE>

fn from(instant: Instant) -> Self

Converts to this type from the input type.

impl<const SCALE: u64> From<Instant> for Timescale<SCALE>

fn from(instant: Instant) -> Self

Converts to this type from the input type.

impl<const SCALE: u64> From<Timescale<SCALE>> for Duration

fn from(time: Timescale<SCALE>) -> Self

Converts to this type from the input type.

impl<const SCALE: u64> Hash for Timescale<SCALE>

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<const SCALE: u64> Ord for Timescale<SCALE>

fn cmp(&self, other: &Timescale<SCALE>) -> 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<const SCALE: u64> PartialEq for Timescale<SCALE>

fn eq(&self, other: &Timescale<SCALE>) -> 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<const SCALE: u64> PartialOrd for Timescale<SCALE>

fn partial_cmp(&self, other: &Timescale<SCALE>) -> 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<const SCALE: u64> Sub for Timescale<SCALE>

type Output = Timescale<SCALE>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const SCALE: u64> SubAssign for Timescale<SCALE>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<const SCALE: u64> TryFrom<Duration> for Timescale<SCALE>

type Error = TimeOverflow

The type returned in the event of a conversion error.

fn try_from(duration: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SCALE: u64> Copy for Timescale<SCALE>

impl<const SCALE: u64> Eq for Timescale<SCALE>

impl<const SCALE: u64> StructuralPartialEq for Timescale<SCALE>