Struct IndexConversion 

pub struct IndexConversion { /* private fields */ }

Result of converting an Instant to a ClockIndex, paired with any diagnostics raised by the conversion.

A conversion is exact when the instant lands on a clock boundary; otherwise the index is rounded toward zero and a warning diagnostic records that the instant was not on an exact boundary.

Examples

use sim_kernel::Symbol;
use sim_lib_stream_clock::{Clock, Instant};

let clock = Clock::frame(Symbol::new("audio"), 48_000)?;
let conversion = clock.index_for_instant(Instant::seconds(1))?;
assert_eq!(conversion.index().value(), 48_000);
assert!(conversion.is_exact());

Implementations

impl IndexConversion

pub fn index(&self) -> ClockIndex

Returns the converted index.

pub fn diagnostics(&self) -> &[Diagnostic]

Returns the diagnostics raised by the conversion, empty when exact.

pub fn is_exact(&self) -> bool

Returns true when the instant landed exactly on a clock boundary.

Trait Implementations

impl Clone for IndexConversion

fn clone(&self) -> IndexConversion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexConversion

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

Formats the value using the given formatter.

impl Eq for IndexConversion

impl PartialEq for IndexConversion

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