Struct songbird::events::EventData

pub struct EventData { /* fields omitted */ }

Internal representation of an event, as handled by the audio context.

Implementations

impl EventData

pub fn new<F: EventHandler + 'static>(event: Event, action: F) -> Self

Create a representation of an event and its associated handler.

An event handler, action, receives an EventContext and optionally produces a new Event type for itself. Returning None will maintain the same event type, while removing any Delayed entries. Event handlers will be re-added with their new trigger condition, or removed if Cancelled

pub fn compute_activation(&mut self, now: Duration)

Computes the next firing time for a timer event.

Trait Implementations

impl Debug for EventData

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

Formats the value using the given formatter.

impl Eq for EventData

impl Ord for EventData

Events are ordered/compared based on their firing time.

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EventData> for EventData

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

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

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

This method tests for !=.

impl PartialOrd<EventData> for EventData

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