Struct ClockIndex 

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

Position on a clock timeline, counted in that clock’s own units (frames for frame clocks, ticks for MIDI clocks).

Examples

use sim_lib_stream_clock::ClockIndex;

let index = ClockIndex::new(48_000);
assert_eq!(index.value(), 48_000);

Implementations

impl ClockIndex

pub fn new(value: u64) -> Self

Wraps a raw count into a clock index.

pub fn value(self) -> u64

Returns the underlying count.

Trait Implementations

impl Clone for ClockIndex

fn clone(&self) -> ClockIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClockIndex

impl Debug for ClockIndex

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

Formats the value using the given formatter.

impl Eq for ClockIndex

impl Ord for ClockIndex

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

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

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