Struct reaper_medium::CommandId

pub struct CommandId(_);

A command ID.

This uniquely identifies a command¹ within a certain section. For built-in actions this command ID is completely stable. For actions added by extensions it should be assumed that the command ID is valid only within one REAPER session.

This is not to be confused with the command index (the position in the action list) and the command name (a globally unique string identifier for commands added by extensions which is stable even across different REAPER sessions).

---

1. A command is a function that will be executed when a particular action is requested to be run. ↩

Implementations

impl CommandId

pub fn new(value: u32) -> CommandId

Creates a command ID.

Panics

This function panics if the given value is 0 (which is not a valid command ID).

pub const unsafe fn new_unchecked(value: u32) -> CommandId

Creates a command ID without bound checking.

Safety

You must ensure that the given value is greater than 0.

pub const fn get(&self) -> u32

Returns the wrapped value.

pub fn to_raw(&self) -> i32

Converts this value to an integer as expected by the low-level API.

Trait Implementations

impl Clone for CommandId

fn clone(&self) -> CommandId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CommandId

impl Debug for CommandId

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for CommandId

fn default() -> CommandId

Returns the "default value" for a type.

impl Display for CommandId

fn fmt(&self, _derive_more_display_formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for CommandId

impl Hash for CommandId

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Ord for CommandId

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialEq<CommandId> for CommandId

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

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

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

This method tests for !=.

impl PartialOrd<CommandId> for CommandId

fn partial_cmp(&self, other: &CommandId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &CommandId) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &CommandId) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &CommandId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &CommandId) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for CommandId

impl StructuralPartialEq for CommandId