Struct web_audio_api::alloc::ChannelData

pub struct ChannelData { /* fields omitted */ }

Single channel audio samples, basically wraps a Rc<[f32; BUFFER_SIZE]>

ChannelData has copy-on-write semantics, so it is cheap to clone.

Implementations

impl ChannelData

pub fn is_silent(&self) -> bool

O(1) check if this buffer is equal to the ‘silence buffer’

If this function returns false, it is still possible for all samples to be zero.

pub fn add(&mut self, other: &Self)

Sum two channels

pub fn silence(&self) -> Self

Methods from Deref<Target = [f32; 128]>

pub fn as_slice(&self) -> &[T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

🔬 This is a nightly-only experimental API. (array_methods)

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods, array_map)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬 This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

Trait Implementations

impl Clone for ChannelData

fn clone(&self) -> ChannelData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for ChannelData

type Target = [f32; 128]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ChannelData

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for ChannelData

fn drop(&mut self)

Executes the destructor for this type.