Struct sample::types::u24::U24

pub struct U24(_);

Methods

impl U24

fn new(val: i32) -> Option<Self>[−]

Construct a new sample if the given value is within range.

Returns None if val is out of range.

fn new_unchecked(s: i32) -> Self[−]

Constructs a new sample without checking for overflowing.

This should only be used if the user can guarantee the sample will be within range and they require the extra performance.

If this function is used, the sample crate can't guarantee that the returned sample or any interacting samples will remain within their MIN and MAX bounds.

fn inner(self) -> i32[−]

Return the internal value used to represent the sample type.

Trait Implementations

impl FromSample<i8> for U24

fn from_sample_(s: i8) -> Self

impl FromSample<i16> for U24

fn from_sample_(s: i16) -> Self

impl FromSample<I24> for U24

fn from_sample_(s: I24) -> Self

impl FromSample<i32> for U24

fn from_sample_(s: i32) -> Self

impl FromSample<I48> for U24

fn from_sample_(s: I48) -> Self

impl FromSample<i64> for U24

fn from_sample_(s: i64) -> Self

impl FromSample<u8> for U24

fn from_sample_(s: u8) -> Self

impl FromSample<u16> for U24

fn from_sample_(s: u16) -> Self

impl FromSample<u32> for U24

fn from_sample_(s: u32) -> Self

impl FromSample<U48> for U24

fn from_sample_(s: U48) -> Self

impl FromSample<u64> for U24

fn from_sample_(s: u64) -> Self

impl FromSample<f32> for U24

fn from_sample_(s: f32) -> Self

impl FromSample<f64> for U24

fn from_sample_(s: f64) -> Self

impl From<i32> for U24

fn from(val: i32) -> Self[−]

Performs the conversion.

impl Add<U24> for U24

type Output = U24

The resulting type after applying the + operator

fn add(self, other: Self) -> Self[−]

The method for the + operator

impl Sub<U24> for U24

type Output = U24

The resulting type after applying the - operator

fn sub(self, other: Self) -> Self[−]

The method for the - operator

impl Mul<U24> for U24

type Output = U24

The resulting type after applying the * operator

fn mul(self, other: Self) -> Self[−]

The method for the * operator

impl Div<U24> for U24

type Output = U24

The resulting type after applying the / operator

fn div(self, other: Self) -> Self[−]

The method for the / operator

impl Not for U24

type Output = U24

The resulting type after applying the ! operator

fn not(self) -> U24[−]

The method for the unary ! operator

impl Rem<U24> for U24

type Output = U24

The resulting type after applying the % operator

fn rem(self, other: Self) -> Self[−]

The method for the % operator

impl Shl<U24> for U24

type Output = U24

The resulting type after applying the << operator

fn shl(self, other: Self) -> Self[−]

The method for the << operator

impl Shr<U24> for U24

type Output = U24

The resulting type after applying the >> operator

fn shr(self, other: Self) -> Self[−]

The method for the >> operator

impl BitAnd<U24> for U24

type Output = U24

The resulting type after applying the & operator

fn bitand(self, other: Self) -> Self[−]

The method for the & operator

impl BitOr<U24> for U24

type Output = U24

The resulting type after applying the | operator

fn bitor(self, other: Self) -> Self[−]

The method for the | operator

impl BitXor<U24> for U24

type Output = U24

The resulting type after applying the ^ operator

fn bitxor(self, other: Self) -> Self[−]

The method for the ^ operator

impl From<u8> for U24

fn from(other: u8) -> Self[−]

Performs the conversion.

impl From<u16> for U24

fn from(other: u16) -> Self[−]

Performs the conversion.

impl From<U20> for U24

fn from(other: U20) -> Self[−]

Performs the conversion.

impl Sample for U24

type Signed = i32

When summing two samples of a signal together, it is necessary for both samples to be represented in some signed format. This associated Addition type represents the format to which Self should be converted for optimal Addition performance.

type Float = f32

When multiplying two samples of a signal together, it is necessary for both samples to be represented in some signed, floating-point format. This associated Multiplication type represents the format to which Self should be converted for optimal Multiplication performance.

fn equilibrium() -> Self[−]

The equilibrium value for the wave that this Sample type represents. This is normally the value that is equal distance from both the min and max ranges of the sample.

fn identity() -> Self::Float[−]

The multiplicative identity of the signal.

fn to_sample<S>(self) -> S where Self: ToSample<S>[−]

Convert self to any type that implements FromSample<Self>.

fn from_sample<S>(s: S) -> Self where Self: FromSample<S>[−]

Create a Self from any type that implements ToSample<Self>.

fn to_signed_sample(self) -> Self::Signed[−]

Converts self to the equivalent Sample in the associated Signed format.

fn to_float_sample(self) -> Self::Float[−]

Converts self to the equivalent Sample in the associated Float format.

fn add_amp(self, amp: Self::Signed) -> Self[−]

Adds (or "offsets") the amplitude of the Sample by the given signed amplitude.

fn mul_amp(self, amp: Self::Float) -> Self[−]

Multiplies (or "scales") the amplitude of the Sample by the given float amplitude.

Derived Implementations

impl Default for U24

fn default() -> U24[−]

Returns the "default value" for a type.

impl Ord for U24

fn cmp(&self, __arg_0: &U24) -> Ordering[−]

This method returns an Ordering between self and other.

impl PartialOrd for U24

fn partial_cmp(&self, __arg_0: &U24) -> Option<Ordering>[−]

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

fn lt(&self, __arg_0: &U24) -> bool[−]

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

fn le(&self, __arg_0: &U24) -> bool[−]

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

fn gt(&self, __arg_0: &U24) -> bool[−]

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

fn ge(&self, __arg_0: &U24) -> bool[−]

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

impl Eq for U24

impl PartialEq for U24

fn eq(&self, __arg_0: &U24) -> bool[−]

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

fn ne(&self, __arg_0: &U24) -> bool[−]

This method tests for !=.

impl Debug for U24

fn fmt(&self, __arg_0: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Clone for U24

fn clone(&self) -> U24[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for U24