Trait Event 

pub unsafe trait Event:
    Sized
    + AsRef<UnknownEvent>
    + 'static {
    type EventSpace<'a>: EventSpace<'a>;

    const TYPE_ID: u16;

    // Provided methods
    fn flags(&self) -> EventFlags { ... }
    fn set_flags(&mut self, flags: EventFlags) { ... }
    fn with_flags(self, flags: EventFlags) -> Self { ... }
    fn time(&self) -> u32 { ... }
    fn set_time(&mut self, time: u32) { ... }
    fn with_time(self, time: u32) -> Self { ... }
    fn header(&self) -> &EventHeader<Self> { ... }
    fn header_mut(&mut self) -> &mut EventHeader<Self> { ... }
    fn as_unknown(&self) -> &UnknownEvent { ... }
    fn raw_header(&self) -> &clap_event_header { ... }
    unsafe fn raw_header_mut(&mut self) -> &mut clap_event_header { ... }
}

A specific event type.

Safety

This trait allows casting to and from pointers to raw event headers. This means implementers of this trait must enforce the following:

• The EventSpace type must be the EventSpace implementation that it belongs to;
• TYPE_ID must match the event ID from its type.
• The type must be ABI-compatible with the matching raw, C-FFI compatible event type.
• All instances of this type must be initialized and valid.

Required Associated Constants

const TYPE_ID: u16

The raw event type identifier for this event type.

This MUST match the identifier defined in the CLAP specification for this event.

Required Associated Types

type EventSpace<'a>: EventSpace<'a>

The event space this event type is a part of.

Provided Methods

fn flags(&self) -> EventFlags

Returns the EventFlags of this event.

fn set_flags(&mut self, flags: EventFlags)

Sets the EventFlags of this event.

fn with_flags(self, flags: EventFlags) -> Self

Builds an event with the given EventFlags, and returns it.

This is useful to use in a builder-style pattern.

fn time(&self) -> u32

Returns the time stamp of this event, in samples.

fn set_time(&mut self, time: u32)

Sets the time stamp of this event, in samples.

fn with_time(self, time: u32) -> Self

Builds an event with the given time stamp, and returns it.

This is useful to use in a builder-style pattern.

fn header(&self) -> &EventHeader<Self>

Returns a shared, immutable reference to this event’s header.

fn header_mut(&mut self) -> &mut EventHeader<Self>

Returns an exclusive, mutable reference to this event’s header.

fn as_unknown(&self) -> &UnknownEvent

Returns this event as a type-erased UnknownEvent.

fn raw_header(&self) -> &clap_event_header

Returns a shared, immutable reference to the raw, C-FFI compatible representation of this header’s event.

unsafe fn raw_header_mut(&mut self) -> &mut clap_event_header

Returns an exclusive, mutable reference to the raw, C-FFI compatible representation of this header’s event.

Safety

This method allows mutating the event header’s fields, most notably type_, size and space_id.

Modifying those fields may trigger Undefined Behavior, as it can make other readers of this event treat it as a type or size that it is actually not.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Event for Midi2Event

const TYPE_ID: u16 = CLAP_EVENT_MIDI2

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for MidiEvent

const TYPE_ID: u16 = CLAP_EVENT_MIDI

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for MidiSysExEvent

const TYPE_ID: u16 = CLAP_EVENT_MIDI_SYSEX

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for NoteChokeEvent

const TYPE_ID: u16 = CLAP_EVENT_NOTE_CHOKE

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for NoteEndEvent

const TYPE_ID: u16 = CLAP_EVENT_NOTE_END

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for NoteExpressionEvent

const TYPE_ID: u16 = CLAP_EVENT_NOTE_EXPRESSION

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for NoteOffEvent

const TYPE_ID: u16 = CLAP_EVENT_NOTE_OFF

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for NoteOnEvent

const TYPE_ID: u16 = CLAP_EVENT_NOTE_ON

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for ParamGestureBeginEvent

const TYPE_ID: u16 = CLAP_EVENT_PARAM_GESTURE_BEGIN

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for ParamGestureEndEvent

const TYPE_ID: u16 = CLAP_EVENT_PARAM_GESTURE_END

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for ParamModEvent

const TYPE_ID: u16 = CLAP_EVENT_PARAM_MOD

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for ParamValueEvent

const TYPE_ID: u16 = CLAP_EVENT_PARAM_VALUE

type EventSpace<'a> = CoreEventSpace<'a>

impl Event for TransportEvent

const TYPE_ID: u16 = CLAP_EVENT_TRANSPORT

type EventSpace<'a> = CoreEventSpace<'a>