Struct I24

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

Implementations

impl I24

pub 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.

pub 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.

pub fn inner(self) -> i32

Return the internal value used to represent the sample type.

Trait Implementations

impl Add for I24

type Output = I24

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl BitAnd for I24

type Output = I24

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self

Performs the & operation.

impl BitOr for I24

type Output = I24

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl BitXor for I24

type Output = I24

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self

Performs the ^ operation.

impl Clone for I24

fn clone(&self) -> I24

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for I24

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

Formats the value using the given formatter.

impl Default for I24

fn default() -> I24

Returns the “default value” for a type.

impl Div for I24

type Output = I24

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl From<I20> for I24

fn from(other: I20) -> Self

Converts to this type from the input type.

impl From<I24> for I48

fn from(other: I24) -> Self

Converts to this type from the input type.

impl From<U20> for I24

fn from(other: U20) -> Self

Converts to this type from the input type.

impl From<i16> for I24

fn from(other: i16) -> Self

Converts to this type from the input type.

impl From<i32> for I24

fn from(val: i32) -> Self

Converts to this type from the input type.

impl From<i8> for I24

fn from(other: i8) -> Self

Converts to this type from the input type.

impl From<u16> for I24

fn from(other: u16) -> Self

Converts to this type from the input type.

impl From<u8> for I24

fn from(other: u8) -> Self

Converts to this type from the input type.

impl FromSample<I24> for I48

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for U24

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for U48

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for f32

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for f64

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for i16

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for i32

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for i64

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for i8

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for u16

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for u32

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for u64

fn from_sample_(s: I24) -> Self

impl FromSample<I24> for u8

fn from_sample_(s: I24) -> Self

impl FromSample<I48> for I24

fn from_sample_(s: I48) -> Self

impl FromSample<U24> for I24

fn from_sample_(s: U24) -> Self

impl FromSample<U48> for I24

fn from_sample_(s: U48) -> Self

impl FromSample<f32> for I24

fn from_sample_(s: f32) -> Self

impl FromSample<f64> for I24

fn from_sample_(s: f64) -> Self

impl FromSample<i16> for I24

fn from_sample_(s: i16) -> Self

impl FromSample<i32> for I24

fn from_sample_(s: i32) -> Self

impl FromSample<i64> for I24

fn from_sample_(s: i64) -> Self

impl FromSample<i8> for I24

fn from_sample_(s: i8) -> Self

impl FromSample<u16> for I24

fn from_sample_(s: u16) -> Self

impl FromSample<u32> for I24

fn from_sample_(s: u32) -> Self

impl FromSample<u64> for I24

fn from_sample_(s: u64) -> Self

impl FromSample<u8> for I24

fn from_sample_(s: u8) -> Self

impl Mul for I24

type Output = I24

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Neg for I24

type Output = I24

The resulting type after applying the - operator.

fn neg(self) -> I24

Performs the unary - operation.

impl Not for I24

type Output = I24

The resulting type after applying the ! operator.

fn not(self) -> I24

Performs the unary ! operation.

impl Ord for I24

fn cmp(&self, other: &I24) -> 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.

impl PartialEq for I24

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for I24

fn partial_cmp(&self, other: &I24) -> 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 Rem for I24

type Output = I24

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl Sample for I24

const EQUILIBRIUM: Self = types::i24::EQUILIBRIUM

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.

type Signed = I24

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.

const IDENTITY: Self::Float = <Self::Float as FloatSample>::IDENTITY

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.

impl Shl for I24

type Output = I24

The resulting type after applying the << operator.

fn shl(self, other: Self) -> Self

Performs the << operation.

impl Shr for I24

type Output = I24

The resulting type after applying the >> operator.

fn shr(self, other: Self) -> Self

Performs the >> operation.

impl Sub for I24

type Output = I24

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Copy for I24

impl Eq for I24

impl SignedSample for I24

impl StructuralPartialEq for I24