Struct ClapId 

pub struct ClapId(/* private fields */);

A standardized CLAP identifier.

Identifiers in CLAP are 32-bit unsigned integers, but where the u32::MAX value is invalid.

This invalid value is generally used in the CLAP ABI to indicate failure.

This type ensures that the invalid value (i.e. u32::MAX) is never used in place of an actual CLAP ID.

Example

use clack_common::utils::ClapId;

let id: ClapId = ClapId::new(42);
assert_eq!(42, id.get());

Implementations

impl ClapId

pub const fn new(id: u32) -> ClapId

Creates a new CLAP identifier from its numeric value.

Panics

This function will panic if id is u32::MAX.

For a non-panicking version, see ClapId::from_raw.

pub const fn from_raw(raw: u32) -> Option<ClapId>

Creates a new CLAP identifier from its raw numeric value.

Returns None if the given id is u32::MAX.

For a panicking version that returns the ClapId directly, see ClapId::new.

pub const fn get(self) -> u32

Gets the underlying numerical value of this ID.

The returned value is guaranteed to never be u32::MAX.

pub const fn optional_to_raw(value: Option<ClapId>) -> u32

Takes an optional identifier, and returns the matching raw, C-FFI compatible value.

This returns the underlying numerical value of the ID if present, or u32::MAX if None.

Trait Implementations

impl Clone for ClapId

fn clone(&self) -> ClapId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClapId

impl Debug for ClapId

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

Formats the value using the given formatter.

impl Display for ClapId

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

Formats the value using the given formatter.

impl Eq for ClapId

impl From<ClapId> for Match<u32>

fn from(value: ClapId) -> Match<u32>

Converts to this type from the input type.

impl From<u32> for ClapId

fn from(value: u32) -> ClapId

Converts to this type from the input type.

impl Hash for ClapId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ClapId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Option<ClapId>> for ClapId

fn eq(&self, other: &Option<ClapId>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<u32> for ClapId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ClapId

fn partial_cmp(&self, other: &ClapId) -> 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 PartialOrd<u32> for ClapId

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