Struct EventSpaceId 

pub struct EventSpaceId<S = ()> { /* private fields */ }

An event space identifier, optionally tied to its EventSpace type S.

If S is the unit type (), then this means this identifier is not tied to any particular event space (i.e. it is type-erased).

Implementations

impl<S> EventSpaceId<S>

pub const INVALID_ID: u16 = u16::MAX

The raw numeric value that represents an invalid event space identifier.

pub const fn id(&self) -> u16

Returns raw numeric value of this identifier.

The returned value cannot be equal to Self::INVALID_ID.

pub const fn optional_id(this: &Option<EventSpaceId<S>>) -> u16

Returns the raw numeric value of the given identifier, or Self::INVALID_ID if the None is passed.

pub const unsafe fn new_unchecked(id: u16) -> EventSpaceId<S>

Gets an event space ID from a numerical value, without performing any checks.

Safety

The caller must ensure the event type is properly associated to the event space S. The caller must also ensure the ID is not equal to Self::INVALID_ID.

impl EventSpaceId<CoreEventSpace<'_>>

pub const fn core() -> EventSpaceId<CoreEventSpace<'_>>

Returns the identifier for the CoreEventSpace.

It is the only event space that has a constant, specific ID designated by the CLAP specification, and which can be retrieved without using an event registry.

impl EventSpaceId

pub const fn new(id: u16) -> Option<EventSpaceId>

Creates a new, type-erased EventSpaceId from its raw numeric value.

This returns None if the passed value is equal to Self::INVALID_ID.

pub const unsafe fn into_unchecked<S>(self) -> EventSpaceId<S>

Turns this unassociated event space ID into one associated with the given event space.

Safety

The caller must ensure the event type is properly associated to the event space S.

Trait Implementations

impl<S> Clone for EventSpaceId<S>

where S: Clone,

fn clone(&self) -> EventSpaceId<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Copy for EventSpaceId<S>

where S: Copy,

impl<S> Eq for EventSpaceId<S>

where S: Eq,

impl<'a, S> From<EventSpaceId<S>> for EventSpaceId

where S: EventSpace<'a>,

fn from(id: EventSpaceId<S>) -> EventSpaceId

Converts to this type from the input type.

impl<S> Ord for EventSpaceId<S>

where S: Ord,

fn cmp(&self, other: &EventSpaceId<S>) -> 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<S> PartialEq for EventSpaceId<S>

where S: PartialEq,

fn eq(&self, other: &EventSpaceId<S>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<S> PartialOrd for EventSpaceId<S>

where S: PartialOrd,

fn partial_cmp(&self, other: &EventSpaceId<S>) -> 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<S> StructuralPartialEq for EventSpaceId<S>

where S: PartialEq,