Struct EventHeader 

pub struct EventHeader<E = ()> { /* private fields */ }

The common metadata header of all CLAP events.

All CLAP events have a common header that contains various metadata about them.

Most of that metadata is information used to discover the event’s type: type_id, space_id and size. This is used internally by the UnknownEvent type to perform downcasting to concrete types.

All events also carry a sample-accurate timestamp (accessible through time), as well as some additional event flags (through flags).

Because event headers internally contain type information for the event, the EventHeader is generic over a specific event type parameter E in order to guarantee that type_id, space_id and size are coherent with the event’s type.

The generic parameter E can either be a concrete Event type (as returned by the Event::header method), or () for headers of an undetermined event type (as returned by the UnknownEvent::header method).

Implementations

impl<E> EventHeader<E>

pub const fn size(&self) -> u32

Returns the size of this event, in bytes.

This size includes the size of the event header itself. If you need only the size of the payload, see payload_size.

pub const fn payload_size(&self) -> u32

Returns the size of this event’s payload, in bytes.

This size does not include the size of the event header itself. If you need to also account for the size of the payload, see size.

pub const fn type_id(&self) -> u16

The raw event type ID.

pub const fn time(&self) -> u32

The timestamp at which this event occurs, in samples.

This timestamp is relative to the frame count of the current process invocation.

pub const fn set_time(&mut self, time: u32)

Sets the timestamp at which this event occurs, in samples.

This timestamp is relative to the frame count of the current process invocation.

pub const fn with_time(self, time: u32) -> EventHeader<E>

Sets the timestamp at which this event occurs, in samples.

This timestamp is relative to the frame count of the current process invocation.

This method takes and returns ownership of the event header, allowing it to be used in a builder-style pattern.

pub const fn flags(&self) -> EventFlags

The event’s flags.

pub const fn set_flags(&mut self, flags: EventFlags)

Sets the event’s flags.

pub const fn with_flags(self, flags: EventFlags) -> EventHeader<E>

Sets the event’s flags.

This method takes and returns ownership of the event header, allowing it to be used in a builder-style pattern.

pub const unsafe fn from_raw_unchecked( header: &clap_event_header, ) -> &EventHeader<E>

Gets a shared reference typed event header from a mutable shared to a raw, C-FFI compatible header struct, without performing any checks.

Safety

The caller must ensure the given header matches the given event type E.

pub const unsafe fn from_raw_unchecked_mut( header: &mut clap_event_header, ) -> &mut EventHeader<E>

Gets a mutable reference typed event header from a mutable reference to a raw, C-FFI compatible header struct, without performing any checks.

Safety

The caller must ensure the given header matches the given event type E.

pub const fn as_raw(&self) -> &clap_event_header

Returns this header as a shared reference to a raw, C-FFI compatible header struct.

pub const unsafe fn as_raw_mut(&mut self) -> &mut clap_event_header

Returns this header as a mutable reference to a raw, C-FFI compatible header struct.

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.

pub const fn into_raw(self) -> clap_event_header

Returns this header as a raw, C-FFI compatible header struct.

impl EventHeader

pub const fn from_raw(header: &clap_event_header) -> &EventHeader

Gets an untyped event header from a raw header.

pub const fn space_id(&self) -> Option<EventSpaceId>

The untyped event space ID, from this untyped event header.

impl<E> EventHeader<E>

where E: Event,

pub const fn new_core(time: u32, flags: EventFlags) -> EventHeader<E>

where E: for<'a> Event<EventSpace<'a> = CoreEventSpace<'a>>,

Creates a new header for a specific core event type, containing the given time and flags.

The type_id, space_id and size members are derived from the E type parameter.

See the event_types module for a list of all the supported core event types.

pub const fn new_for_space( space_id: EventSpaceId<<E as Event>::EventSpace<'_>>, time: u32, flags: EventFlags, ) -> EventHeader<E>

Creates a new header for a specific event type, of a given custom event space, containing the given time and flags.

The type_id and size members are derived from the E type parameter.

pub const fn space_id(&self) -> EventSpaceId<<E as Event>::EventSpace<'static>>

The typed event space ID from this event header.

Trait Implementations

impl<E> Clone for EventHeader<E>

where E: Clone,

fn clone(&self) -> EventHeader<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> Copy for EventHeader<E>

where E: Copy,

impl<E> Debug for EventHeader<E>

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

Formats the value using the given formatter.

impl<E> Default for EventHeader<E>

where E: for<'a> Event<EventSpace<'a> = CoreEventSpace<'a>>,

fn default() -> EventHeader<E>

Returns the “default value” for a type.

impl<E> Eq for EventHeader<E>

impl<E> Ord for EventHeader<E>

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<E> PartialEq for EventHeader<E>

fn eq(&self, other: &EventHeader<E>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<E> PartialOrd for EventHeader<E>

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