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 duration since an unspecified origin point. The origin is guaranteed to occur at or before the stream starts, and remains consistent for the lifetime of that stream. Different streams may have different origins.

Host StreamInstant Sources

Host	Source
alsa	snd_pcm_status_get_htstamp
coreaudio	mach_absolute_time
wasapi	QueryPerformanceCounter
asio	timeGetTime
emscripten	AudioContext.getOutputTimestamp

Implementations

impl StreamInstant

pub fn duration_since(&self, earlier: &Self) -> Option<Duration>

The amount of time elapsed from another instant to this one.

Returns None if earlier is later than self.

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

Returns the instant in time after the given duration has passed.

Returns None if the resulting instant would exceed the bounds of the underlying data structure.

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

Returns the instant in time one duration ago.

Returns None if the resulting instant would underflow. As a result, it is important to consider that on some platforms the StreamInstant may begin at 0 from the moment the source stream is created.

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

Trait Implementations

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 Debug for StreamInstant

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

Formats the value using the given formatter.

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 Copy for StreamInstant

impl Eq for StreamInstant

impl StructuralPartialEq for StreamInstant