Struct audio::wrap::Interleaved

pub struct Interleaved<T> { /* private fields */ }

A wrapper for an interleaved audio buffer.

See wrap::interleaved.

Implementations

impl<T> Interleaved<T>

where T: Slice,

pub fn into_inner(self) -> T

Convert back into the wrapped value.

Examples

let buf = audio::wrap::interleaved(&[1, 2, 3, 4], 2);
assert_eq!(buf.into_inner(), &[1, 2, 3, 4]);

pub fn iter(&self) -> IterChannels<'_, T::Item>

Construct an iterator over the interleaved wrapper.

Examples

let buf = audio::wrap::interleaved(&[1, 2, 3, 4], 2);
let mut it = buf.iter();

assert_eq!(it.next().unwrap(), [1, 3]);
assert_eq!(it.next().unwrap(), [2, 4]);

impl<T> Interleaved<T>

where T: SliceMut,

pub fn iter_mut(&mut self) -> IterChannelsMut<'_, T::Item>

Construct an iterator over the interleaved wrapper.

Trait Implementations

impl<T> Buf for Interleaved<T>

where T: Slice,

type Sample = <T as Slice>::Item

The type of a single sample.

type Channel<'this> = InterleavedChannel<'this, <Interleaved<T> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, <Interleaved<T> as Buf>::Sample> where Self: 'this

An iterator over available channels.

fn frames_hint(&self) -> Option<usize>

A typical number of frames for each channel in the buffer, if known.

fn channels(&self) -> usize

The number of channels in the buffer.

fn get_channel(&self, channel: usize) -> Option<Self::Channel<'_>>

Return a handler to the buffer associated with the channel.

fn iter_channels(&self) -> Self::IterChannels<'_>

Construct an iterator over all the channels in the audio buffer.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Construct a wrapper around this buffer that skips the first n frames.

fn tail(self, n: usize) -> Tail<Self>

where Self: Sized,

Construct a wrapper around this buffer that skips to the last n frames.

fn limit(self, limit: usize) -> Limit<Self>

where Self: Sized,

Construct a wrapper around this buffer which stops after limit frames.

impl<T> BufMut for Interleaved<T>

where T: SliceMut,

type ChannelMut<'this> = InterleavedChannelMut<'this, <T as Slice>::Item> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, <Interleaved<T> as Buf>::Sample> where Self: 'this

A mutable iterator over available channels.

fn get_channel_mut(&mut self, channel: usize) -> Option<Self::ChannelMut<'_>>

Return a mutable handler to the buffer associated with the channel.

fn copy_channel(&mut self, from: usize, to: usize)

Copy one channel into another.

fn iter_channels_mut(&mut self) -> Self::IterChannelsMut<'_>

Construct a mutable iterator over available channels.

impl<T> ExactSizeBuf for Interleaved<T>

where T: Slice,

fn frames(&self) -> usize

The number of frames in a buffer.

impl<T> InterleavedBuf for Interleaved<T>

where T: Slice,

type Sample = <T as Slice>::Item

The type of a single sample.

fn as_interleaved(&self) -> &[Self::Sample]

Access the underlying raw interleaved buffer.

impl<T> InterleavedBufMut for Interleaved<T>

where T: SliceMut,

fn as_interleaved_mut(&mut self) -> &mut [Self::Sample]

Access the underlying interleaved mutable buffer.

fn as_interleaved_mut_ptr(&mut self) -> NonNull<Self::Sample>

Access a pointer to the underlying interleaved mutable buffer.

unsafe fn set_interleaved_topology(&mut self, channels: usize, frames: usize)

Specify the topology of the underlying interleaved buffer.

impl<T> ReadBuf for Interleaved<T>

where T: Default + SliceIndex,

fn remaining(&self) -> usize

Get the number of frames remaining that can be read from the buffer.

fn advance(&mut self, n: usize)

Advance the read number of frames by n.

fn has_remaining(&self) -> bool

Test if there are any remaining frames to read.

impl<T> ResizableBuf for Interleaved<&mut [T]>

where T: Copy,

fn try_reserve(&mut self, capacity: usize) -> bool

Ensure that the audio buffer has space for at least the given capacity of contiguous memory. The capacity is specified in number of Samples.

fn resize_frames(&mut self, frames: usize)

Resize the number of per-channel frames in the buffer.

fn resize_topology(&mut self, channels: usize, frames: usize)

Resize the buffer to match the given topology.

impl<T> UniformBuf for Interleaved<T>

where T: Slice,

type Frame<'this> = InterleavedFrame<'this, <T as Slice>::Item> where Self: 'this

The type the channel assumes when coerced into a reference.

type IterFrames<'this> = InterleavedFramesIter<'this, <T as Slice>::Item> where Self: 'this

A borrowing iterator over the channel.

fn get_frame(&self, frame: usize) -> Option<Self::Frame<'_>>

Get a single frame at the given offset.

fn iter_frames(&self) -> Self::IterFrames<'_>

Construct an iterator over all the frames in the audio buffer.

impl<T> WriteBuf for Interleaved<&mut [T]>

where T: Copy,

fn remaining_mut(&self) -> usize

Remaining number of frames that can be written.

fn advance_mut(&mut self, n: usize)

Advance the number of frames that have been written.

fn has_remaining_mut(&self) -> bool

Test if this buffer has remaining mutable frames that can be written.