Struct midi_file::core::PitchBendValue

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

Represents the MIDI pitch bend value. The minimum value is 0, the maximum value is 16383 (i.e. u14). This type will clamp values to the valid range.

Implementations

impl PitchBendValue

pub const fn new(value: u16) -> Self

Silently clamps the value if it is out of range. See Self::set.

pub fn get(&self) -> u16

Returns the inner value.

pub fn set(&mut self, value: u16) -> bool

Clamps and sets. Returns true if value was in range. Returns false if value was out-of-range. That is, given a valid range of 1..=5, then set(0) will set the value to 1 and return false. set(4) will set the value to 4 and return true.

Trait Implementations

impl Clone for PitchBendValue

fn clone(&self) -> PitchBendValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PitchBendValue

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

Formats the value using the given formatter.

impl Default for PitchBendValue

fn default() -> Self

Returns the “default value” for a type.

impl Display for PitchBendValue

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

Formats the value using the given formatter.

impl From<PitchBendValue> for u16

fn from(value: PitchBendValue) -> u16

Converts to this type from the input type.

impl From<u16> for PitchBendValue

fn from(value: u16) -> Self

Converts to this type from the input type.

impl Hash for PitchBendValue

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PitchBendValue

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PitchBendValue

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PitchBendValue

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

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

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

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

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

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

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

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

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

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

impl Copy for PitchBendValue

impl Eq for PitchBendValue

impl StructuralEq for PitchBendValue

impl StructuralPartialEq for PitchBendValue