Struct sorceress::pattern::Event

pub struct Event<M> {
    pub delta: f64,
    pub event: EventOrRest<M>,
}

An occurrence with timing information.

Events are used in Patterns to describe things that occur at a specific time. Events are most commonly used to describe musical events such as a note playing or a pitch changing, but can be used to describe any occurrence. The only information that is required by all events is a delta which determines the time delay until the next event in a sequence.

Examples

use sorceress::pattern::{Event, EventOrRest};

let event = Event::new(1.0, "hello");
let rest = Event::rest(2.0);

assert_eq!(
    event,
    Event {
        delta: 1.0,
        event: EventOrRest::Event("hello".to_owned()),
    }
);
assert_eq!(
    rest,
    Event::<String> {
        delta: 2.0,
        event: EventOrRest::Rest,
    }
);

Fields

delta: f64

The “logical time” delay until the next event. Instead of being specified as a Duration, delta is a floating point number. This lets whatever schedules the event determine how the delta value should be intepreted. For example: a tempo-aware scheduler can intepret the delta as a number of beats.

event: EventOrRest<M>

The event data or a musical rest.

Implementations

impl<M> Event<M>

pub fn new(delta: f64, event: impl Into<M>) -> Event<M>

Create a new event.

pub fn rest(delta: f64) -> Event<M>

Create a rest event.

Trait Implementations

impl<M: Clone> Clone for Event<M>

fn clone(&self) -> Event<M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for Event<M>

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

Formats the value using the given formatter.

impl<M: PartialEq> PartialEq<Event<M>> for Event<M>

fn eq(&self, other: &Event<M>) -> bool

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

fn ne(&self, other: &Event<M>) -> bool

This method tests for !=.

impl<M: PartialOrd> PartialOrd<Event<M>> for Event<M>

fn partial_cmp(&self, other: &Event<M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<M> StructuralPartialEq for Event<M>