Trait audio_core::Sample

pub unsafe trait Sample: Copy {
    const ZERO: Self;
}

A sample that can be stored in an audio buffer. Types implementing this are known as being sample apt.

Sample apt types have the following gurantees:

• The type does not need to be dropped (by implementing Copy).
• The type can safely be initialized with the all-zeros bit pattern.

Safety

Implementor must make sure that a bit-pattern of all-zeros is a legal bit-pattern for the implemented type.

Required Associated Constants

const ZERO: Self

The zero pattern for the sample.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl Sample for f32

The bit-pattern of all zeros is a legal bit-pattern for floats.

See for example: https://doc.rust-lang.org/std/primitive.f32.html#method.to_bits.

Proof:

use audio::Sample;

assert_eq!((f64::ZERO).to_bits(), 0u64);

const ZERO: Self = 0f32

impl Sample for f64

The bit-pattern of all zeros is a legal bit-pattern for floats.

See for example: https://doc.rust-lang.org/std/primitive.f64.html#method.to_bits.

Proof:

use audio::Sample;

assert_eq!((f64::ZERO).to_bits(), 0u64);

const ZERO: Self = 0f64

impl Sample for i8

const ZERO: Self = 0i8

impl Sample for i16

const ZERO: Self = 0i16

impl Sample for i32

const ZERO: Self = 0i32

impl Sample for i64

const ZERO: Self = 0i64

impl Sample for i128

const ZERO: Self = 0i128

impl Sample for isize

const ZERO: Self = 0isize

impl Sample for u8

const ZERO: Self = 0u8

impl Sample for u16

const ZERO: Self = 0u16

impl Sample for u32

const ZERO: Self = 0u32

impl Sample for u64

const ZERO: Self = 0u64

impl Sample for u128

const ZERO: Self = 0u128

impl Sample for usize

const ZERO: Self = 0usize

impl<const N: usize> Sample for [u8; N]

const ZERO: Self = _

Implementors