Struct cpal::StreamInstant

pub struct StreamInstant { /* fields omitted */ }

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 some unspecified origin occurring either before or equal to the moment the stream from which it was created begins.

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.

Trait Implementations

impl Clone for StreamInstant

fn clone(&self) -> StreamInstant

Returns a copy 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, 

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.

#[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

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

Restrict a value to a certain interval.

impl PartialEq<StreamInstant> for StreamInstant

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

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

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

This method tests for !=.

impl PartialOrd<StreamInstant> 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: &StreamInstant) -> bool

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

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

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

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

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

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

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

impl StructuralEq for StreamInstant

impl StructuralPartialEq for StreamInstant