Struct BipolarOf 

pub struct BipolarOf<const LIMIT: i16, const UNIT: u8> { /* private fields */ }

A 0..=127 slot whose musical zero is its centre, reading ±LIMIT of the unit UNIT codes either side.

The Stage equalizer bands are the clearest case: the manuals give “the boost/cut range is +/- 15 dB” for all three models, and rendering those on Level’s 0..10 reads a cut as a small boost.

⚠️ The unit is the declaration’s, not the shape’s: a ±10 modulation amount is not decibels because an equalizer band is. Name it through EqBand or Bipolar rather than writing the code out.

⚠️ The centre is taken as 64 — the midpoint of the slot. Inferred from specimens; not confirmed on hardware. The corpus does not distinguish 63 from 64, and no manual states it. A reading is therefore accurate at the endpoints and approximate in between.

Implementations

impl<const LIMIT: i16, const UNIT: u8> BipolarOf<LIMIT, UNIT>

pub const MAX: u8 = 127

pub const CENTER: u8 = 64

The stored value that reads as zero.

pub const UNIT: Unit

What the reading is in.

pub fn new(value: u8) -> Result<Self, ParseError>

pub fn as_u8(&self) -> u8

The stored value, 0..=127.

pub fn reading(&self) -> f32

The panel’s signed reading, -LIMIT..=+LIMIT.

Trait Implementations

impl<const LIMIT: i16, const UNIT: u8> Clone for BipolarOf<LIMIT, UNIT>

fn clone(&self) -> BipolarOf<LIMIT, UNIT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const LIMIT: i16, const UNIT: u8> Copy for BipolarOf<LIMIT, UNIT>

impl<const LIMIT: i16, const UNIT: u8> Debug for BipolarOf<LIMIT, UNIT>

The stored byte, so a retype from a plain integer leaves the field dumps alone.

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

Formats the value using the given formatter.

impl<const LIMIT: i16, const UNIT: u8> Default for BipolarOf<LIMIT, UNIT>

fn default() -> BipolarOf<LIMIT, UNIT>

Returns the “default value” for a type.

impl<const LIMIT: i16, const UNIT: u8> Display for BipolarOf<LIMIT, UNIT>

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

Stored byte and signed reading: 96 (+7.5).

impl<const LIMIT: i16, const UNIT: u8> Eq for BipolarOf<LIMIT, UNIT>

impl<const LIMIT: i16, const UNIT: u8> Hash for BipolarOf<LIMIT, UNIT>

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<const LIMIT: i16, const UNIT: u8> Ord for BipolarOf<LIMIT, UNIT>

fn cmp(&self, other: &BipolarOf<LIMIT, UNIT>) -> 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<const LIMIT: i16, const UNIT: u8> Packed for BipolarOf<LIMIT, UNIT>

const MAX_BITS: u32 = 7

Bits the widest value of this type occupies. Used to check statically that it fits its slot.

const DECODE_BITS: u32 = u8::BITS

Widest slot this type can decode without losing bits on re-encoding.

const CONTROL: ControlKind

Which panel control this value is, for a caller building an interface over the field registry.

type Error = ParseError

Why a bit pattern is not a valid value. Infallible when every pattern is.

fn from_bits(bits: u64) -> Result<Self, ParseError>

Decode from the field’s bits, already shifted down to bit 0 and masked.

fn to_bits(&self) -> u64

Encode to the field’s bits, in the same shifted-down form.

impl<const LIMIT: i16, const UNIT: u8> PartialEq for BipolarOf<LIMIT, UNIT>

fn eq(&self, other: &BipolarOf<LIMIT, UNIT>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<const LIMIT: i16, const UNIT: u8> PartialEq<u8> for BipolarOf<LIMIT, UNIT>

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

Equality operator ==.

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

Inequality operator !=.

impl<const LIMIT: i16, const UNIT: u8> PartialOrd for BipolarOf<LIMIT, UNIT>

fn partial_cmp(&self, other: &BipolarOf<LIMIT, UNIT>) -> 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<const LIMIT: i16, const UNIT: u8> StructuralPartialEq for BipolarOf<LIMIT, UNIT>

impl<const LIMIT: i16, const UNIT: u8> TryFrom<u8> for BipolarOf<LIMIT, UNIT>

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, ParseError>

Performs the conversion.