Struct u24

#[repr(C)]
pub struct u24(pub u8, pub u8, pub u8);

• The tuple struct is little-endian

Tuple Fields

0: u8

1: u8

2: u8

Implementations

impl u24

pub const MAX: u24

pub const MIN: u24

pub fn from_le_bytes(bytes: [u8; 3]) -> Self

pub fn from_be_bytes(bytes: [u8; 3]) -> Self

pub fn to_le_bytes(self) -> [u8; 3]

pub fn to_be_bytes(self) -> [u8; 3]

pub fn as_i128(self) -> i128

pub fn as_i64(self) -> i64

pub fn as_i32(self) -> i32

pub fn as_i16(self) -> i16

pub fn as_i8(self) -> i8

pub fn as_u128(self) -> u128

pub fn as_u64(self) -> u64

pub fn as_u32(self) -> u32

pub fn as_u16(self) -> u16

pub fn as_u8(self) -> u8

pub fn as_f32(self) -> f32

pub fn as_f64(self) -> f64

pub fn clamp(self, min: Self, max: Self) -> Self

Trait Implementations

impl Add for u24

type Output = u24

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for u24

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd for u24

type Output = u24

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for u24

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for u24

type Output = u24

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for u24

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for u24

type Output = u24

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for u24

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for u24

fn clone(&self) -> u24

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for u24

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

Formats the value using the given formatter.

impl Default for u24

fn default() -> Self

Returns the “default value” for a type.

impl Display for u24

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

Formats the value using the given formatter.

impl Div for u24

type Output = u24

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign for u24

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<f32> for u24

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for u24

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i128> for u24

fn from(v: i128) -> Self

Converts to this type from the input type.

impl From<i16> for u24

fn from(v: i16) -> Self

Converts to this type from the input type.

impl From<i24> for u24

fn from(v: i24) -> Self

Converts to this type from the input type.

impl From<i32> for u24

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for u24

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<i8> for u24

fn from(v: i8) -> Self

Converts to this type from the input type.

impl From<u128> for u24

fn from(v: u128) -> Self

Converts to this type from the input type.

impl From<u16> for u24

fn from(v: u16) -> Self

Converts to this type from the input type.

impl From<u24> for i24

fn from(v: u24) -> Self

Converts to this type from the input type.

impl From<u32> for u24

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for u24

fn from(v: u64) -> Self

Converts to this type from the input type.

impl From<u8> for u24

fn from(v: u8) -> Self

Converts to this type from the input type.

impl Hash for u24

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 Into<f32> for u24

fn into(self) -> f32

Converts this type into the (usually inferred) input type.

impl Into<f64> for u24

fn into(self) -> f64

Converts this type into the (usually inferred) input type.

impl Into<i128> for u24

fn into(self) -> i128

Converts this type into the (usually inferred) input type.

impl Into<i16> for u24

fn into(self) -> i16

Converts this type into the (usually inferred) input type.

impl Into<i32> for u24

fn into(self) -> i32

Converts this type into the (usually inferred) input type.

impl Into<i64> for u24

fn into(self) -> i64

Converts this type into the (usually inferred) input type.

impl Into<i8> for u24

fn into(self) -> i8

Converts this type into the (usually inferred) input type.

impl Into<u128> for u24

fn into(self) -> u128

Converts this type into the (usually inferred) input type.

impl Into<u16> for u24

fn into(self) -> u16

Converts this type into the (usually inferred) input type.

impl Into<u32> for u24

fn into(self) -> u32

Converts this type into the (usually inferred) input type.

impl Into<u64> for u24

fn into(self) -> u64

Converts this type into the (usually inferred) input type.

impl Into<u8> for u24

fn into(self) -> u8

Converts this type into the (usually inferred) input type.

impl Mul for u24

type Output = u24

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign for u24

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for u24

type Output = u24

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for u24

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

fn eq(&self, other: &u24) -> 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 u24

fn partial_cmp(&self, other: &Self) -> 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 u24

type Output = u24

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl RemAssign for u24

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl SampleFrom for u24

type ImplFor = u24

The type we are implementating for

fn to<S>(s: S) -> Self

where S: SampleType,

The to<S> method, input any type of SampleType value, then scale it to ImplFor type.

fn as_<S>(s: S) -> Self

where S: SampleType,

The as_<S> method, input any type of SampleType value, then cast it to ImplFor type.

fn sin<S>(s: S) -> Self

where S: SampleType,

Sine wave generator

fn cos<S>(s: S) -> Self

where S: SampleType,

Cosine wave generator

impl SampleType for u24

const MIDNUM: u24

The middle number, e.g. for u16, the middle number is 32768.

const TYPE_NAME: &str = "u24"

The type name, to avoid using std::any::type_name

type ImplFor = u24

The type we are implementating for

type Longer = u32

The longer type, e.g. for i8, the longer type is i16

type Shorter = u16

The shorter type, e.g. for i16, the shorter type is i8

type Signed = i24

The signed type, e.g. for u32, the signed type is i32.

type Unsigned = u24

The Unsigned type, e.g. for i32, the unsigned type is u32.

fn new() -> Self

Create a new sample, the value is the middle value of the range of the format.

fn zero() -> Self

Create a new sample, the value is zero.

fn scale_from<T>(v: T) -> Self

where T: SampleType,

Scale a sample to this specified format.

fn cast_from<T>(v: T) -> Self

where T: SampleType,

Cast a sample to this specified format.

fn average(s1: Self, s2: Self) -> Self

Get the average value of two samples.

fn average_arr(arr: &[Self]) -> Self

Get the average value from a sample array.

fn to_i8(self) -> i8

Scale to i8 range

fn to_i16(self) -> i16

Scale to i16 range

fn to_i24(self) -> i24

Scale to i24 range

fn to_i32(self) -> i32

Scale to i32 range

fn to_i64(self) -> i64

Scale to i64 range

fn to_u8(self) -> u8

Scale to u8 range

fn to_u16(self) -> u16

Scale to u16 range

fn to_u24(self) -> u24

Scale to u24 range

fn to_u32(self) -> u32

Scale to u32 range

fn to_u64(self) -> u64

Scale to u64 range

fn to_f32(self) -> f32

Scale to [-1.0, 1.0] range

fn to_f64(self) -> f64

Scale to [-1.0, 1.0] range

fn to_i128(self) -> i128

Scale to i128 range

fn to_u128(self) -> u128

Scale to u128 range

fn as_i8(self) -> i8

Cast to i8

fn as_i16(self) -> i16

Cast to i16

fn as_i24(self) -> i24

Cast to i24

fn as_i32(self) -> i32

Cast to i32

fn as_i64(self) -> i64

Cast to i64

fn as_u8(self) -> u8

Cast to u8

fn as_u16(self) -> u16

Cast to u16

fn as_u24(self) -> u24

Cast to u24

fn as_u32(self) -> u32

Cast to u32

fn as_u64(self) -> u64

Cast to u64

fn as_f32(self) -> f32

Cast to f32

fn as_f64(self) -> f64

Cast to f64

fn as_i128(self) -> i128

Cast to i128

fn as_u128(self) -> u128

Cast to u128

fn clamp_to_i8(self) -> i8

Clamp to i8

fn clamp_to_i16(self) -> i16

Clamp to i16

fn clamp_to_i24(self) -> i24

Clamp to i24

fn clamp_to_i32(self) -> i32

Clamp to i32

fn clamp_to_i64(self) -> i64

Clamp to i64

fn clamp_to_u8(self) -> u8

Clamp to u8

fn clamp_to_u16(self) -> u16

Clamp to u16

fn clamp_to_u24(self) -> u24

Clamp to u24

fn clamp_to_u32(self) -> u32

Clamp to u32

fn clamp_to_u64(self) -> u64

Clamp to u64

fn clamp_to_f32(self) -> f32

Clamp to f32

fn clamp_to_f64(self) -> f64

Clamp to f64

fn clamp_to_i128(self) -> i128

Clamp to i128

fn clamp_to_u128(self) -> u128

Clamp to u128

fn to_longer(self) -> Self::Longer

Scale to a longer type, the longest type is i128 or u128

fn to_shorter(self) -> Self::Shorter

Scale to a shorter type, the shortest type is i8 or u8

fn as_longer(self) -> Self::Longer

Cast to a longer type, the longest type is i128 or u128

fn as_shorter(self) -> Self::Shorter

Cast to a shorter type, the shortest type is i8 or u8

fn is_signed() -> bool

Is this type a signed type?

fn is_unsigned() -> bool

Is this type an unsigned type?

fn is_integer() -> bool

Is this type an integer type?

fn is_float() -> bool

Is this type an IEEE 754 floating point number type?

fn to_signed(self) -> Self::Signed

Convert to a signed number type. No effects to f32 and f64

fn to_unsigned(self) -> Self::Unsigned

Convert to an unsigned number type. No effects to f32 and f64

fn read_le<T>(r: &mut T) -> Result<Self, Error>

where T: Read + ?Sized,

Read from a reader by little-endian

fn read_be<T>(r: &mut T) -> Result<Self, Error>

where T: Read + ?Sized,

Read from a reader by big-endian

fn write_le<T>(self, w: &mut T) -> Result<(), Error>

where T: Write + ?Sized,

Write to a writer by little-endian

fn write_be<T>(self, w: &mut T) -> Result<(), Error>

where T: Write + ?Sized,

Write to a writer by big-endian

fn sin<S>(self) -> S

where S: SampleType,

Sine wave generator

fn cos<S>(self) -> S

where S: SampleType,

Cosine wave generator

fn interpolate(self, target: Self, s: f64) -> Self

interpolate between self to target by s

fn sizeof(self) -> usize

Get the size of the sample in bytes

impl Shl for u24

type Output = u24

The resulting type after applying the << operator.

fn shl(self, rhs: Self) -> Self::Output

Performs the << operation.

impl ShlAssign for u24

fn shl_assign(&mut self, rhs: Self)

Performs the <<= operation.

impl Shr for u24

type Output = u24

The resulting type after applying the >> operator.

fn shr(self, rhs: Self) -> Self::Output

Performs the >> operation.

impl ShrAssign for u24

fn shr_assign(&mut self, rhs: Self)

Performs the >>= operation.

impl Sub for u24

type Output = u24

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for u24

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for u24

impl Eq for u24

impl StructuralPartialEq for u24