Struct StreamInstant 

pub struct StreamInstant { /* private fields */ }

A monotonic time instance associated with a stream, retrieved from either:

1. A timestamp provided to the stream’s underlying audio data callback or
2. The same time source used to generate timestamps for a stream’s underlying audio data callback.

StreamInstant represents a moment on a stream’s monotonic clock. Because the underlying clock is monotonic, StreamInstant values are always positive and increasing.

Within a single stream, all instants share the same clock, so arithmetic between them is meaningful. Across different streams, origins are not guaranteed to be shared. On some hosts each stream starts its own independent clock at zero, so subtracting a timestamp from one stream and one from another may produce a meaningless result.

Time sources by host

Host	Time source
AAudio	AAudioStream_getTimestamp(CLOCK_MONOTONIC)
ALSA	snd_pcm_status_get_htstamp()
ASIO	timeGetTime()
AudioWorklet	AudioContext.currentTime
CoreAudio	mach_absolute_time()
JACK	jack_get_time()
PipeWire	pw_stream_get_time_n()
PulseAudio	std::time::Instant
WASAPI	QueryPerformanceCounter()
WebAudio	AudioContext.currentTime

Disclaimer: These system calls might change over time.

Note: The + and - operators on StreamInstant may panic if the result cannot be represented as a StreamInstant. Use checked_add or checked_sub for non-panicking variants.

Implementations

impl StreamInstant

pub const ZERO: Self

A StreamInstant with secs and nanos both set to zero.

pub fn checked_duration_since(&self, earlier: StreamInstant) -> Option<Duration>

Returns the amount of time elapsed from earlier to self, or None if earlier is later than self.

pub fn saturating_duration_since(&self, earlier: StreamInstant) -> Duration

Returns the amount of time elapsed from earlier to self, saturating to Duration::ZERO if earlier is later than self.

pub fn duration_since(&self, earlier: StreamInstant) -> Duration

Returns the amount of time elapsed from earlier to self, saturating to Duration::ZERO if earlier is later than self.

pub fn checked_add(&self, duration: Duration) -> Option<Self>

Returns Some(t) where t is self + duration, or None if the result cannot be represented as a StreamInstant.

pub fn checked_sub(&self, duration: Duration) -> Option<Self>

Returns Some(t) where t is self - duration, or None if the result cannot be represented as a StreamInstant (i.e. would be negative).

pub fn as_nanos(&self) -> u128

Returns the total number of nanoseconds contained by this StreamInstant.

pub fn from_nanos(nanos: u64) -> Self

Creates a new StreamInstant from the specified number of nanoseconds.

Note: Using this on the return value of as_nanos() might cause unexpected behavior: as_nanos() returns a u128, and can return values that do not fit in u64, e.g. 585 years. Instead, consider using the pattern StreamInstant::new(t.as_secs(), t.subsec_nanos()) if you cannot copy/clone the StreamInstant directly.

pub fn from_millis(millis: u64) -> Self

Creates a new StreamInstant from the specified number of milliseconds.

pub fn from_micros(micros: u64) -> Self

Creates a new StreamInstant from the specified number of microseconds.

pub fn from_secs_f64(secs: f64) -> Self

Creates a new StreamInstant from the specified number of seconds represented as f64.

Panics

Panics if secs is negative, not finite, or overflows the range of StreamInstant.

pub fn new(secs: u64, nanos: u32) -> Self

Creates a new StreamInstant from the specified number of whole seconds and additional nanoseconds.

If nanos is greater than or equal to 1 billion (the number of nanoseconds in a second), the excess carries over into secs.

Panics

Panics if the carry from nanos overflows the seconds counter.

Trait Implementations

impl Add<Duration> for StreamInstant

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

Panics

Panics if the result overflows the range of StreamInstant. Use checked_add for a non-panicking variant.

type Output = StreamInstant

The resulting type after applying the + operator.

impl AddAssign<Duration> for StreamInstant

fn add_assign(&mut self, rhs: Duration)

Performs the += operation.

impl Clone for StreamInstant

fn clone(&self) -> StreamInstant

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamInstant

impl Debug for StreamInstant

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

Formats the value using the given formatter.

impl Eq for StreamInstant

impl Hash for StreamInstant

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 StreamInstant

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

fn eq(&self, other: &StreamInstant) -> 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 StreamInstant

fn partial_cmp(&self, other: &StreamInstant) -> 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 StructuralPartialEq for StreamInstant

impl Sub for StreamInstant

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

Returns the duration from rhs to self, saturating to Duration::ZERO if rhs is later than self.

type Output = Duration

The resulting type after applying the - operator.

impl Sub<Duration> for StreamInstant

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

Panics

Panics if the result underflows the range of StreamInstant. Use checked_sub for a non-panicking variant.

type Output = StreamInstant

The resulting type after applying the - operator.

impl SubAssign<Duration> for StreamInstant

fn sub_assign(&mut self, rhs: Duration)

Performs the -= operation.