Struct EventTag

pub struct EventTag {
    pub offset_from_t0: Duration,
    pub microstep: MicroStep,
}

The tag of an event.

Tags correspond to a point on the logical timeline, and also implement superdense time, which means an infinite sequence of tags may be processed for any logical instant. The label on this sequence is called the microstep of the tag.

Use the tag! macro to create this struct with convenient syntax.

Fields

offset_from_t0: Duration

The time offset from the origin of the logical timeline. Knowing the start time of the application is necessary to convert this to an absolute Instant (see Self::to_logical_time).

microstep: MicroStep

The microstep of this tag.

Implementations

impl EventTag

pub const ORIGIN: EventTag

The tag of the startup event.

pub fn to_logical_time(&self, t0: Instant) -> Instant

Returns the logical instant for this tag, using the initial time t0.

pub fn duration_since_start(&self) -> Duration

Returns the amount of time elapsed since the start of the app.

assert_eq!(tag1.duration_since_start(), tag1.to_logical_time(t0) - t0)

pub fn microstep(&self) -> MicroStep

Returns the microstep of this tag.

pub fn offset(offset_from_t0: Duration, microstep: u32) -> Self

Create a new tag from its offset from t0 and a microstep. Use the tag! macro for more convenient syntax.

Trait Implementations

impl Clone for EventTag

fn clone(&self) -> EventTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventTag

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

Formats the value using the given formatter.

impl Display for EventTag

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

Formats the value using the given formatter.

impl Hash for EventTag

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 EventTag

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

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

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

impl Eq for EventTag

impl StructuralPartialEq for EventTag