Struct rotary::wrap::Interleaved

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

A wrapper for an interleaved audio buffer.

See wrap::interleaved.

Implementations

impl<T> Interleaved<T>

pub fn into_inner(self) -> T

Convert back into the wrapped value.

Examples

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

Trait Implementations

impl<T> AsInterleaved<T> for Interleaved<&[T]>

fn as_interleaved(&self) -> &[T]

Access the underlying raw interleaved buffer.

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

fn as_interleaved(&self) -> &[T]

Access the underlying raw interleaved buffer.

impl<T, const N: usize> AsInterleaved<T> for Interleaved<[T; N]>

fn as_interleaved(&self) -> &[T]

Access the underlying raw interleaved buffer.

impl<T, const N: usize> AsInterleaved<T> for Interleaved<&[T; N]>

fn as_interleaved(&self) -> &[T]

Access the underlying raw interleaved buffer.

impl<T, const N: usize> AsInterleaved<T> for Interleaved<&mut [T; N]>

fn as_interleaved(&self) -> &[T]

Access the underlying raw interleaved buffer.

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

fn as_interleaved_mut(&mut self) -> &mut [T]

Access the underlying interleaved mutable buffer.

pub fn as_interleaved_mut_ptr(&mut self) -> *mut T

Access a pointer to the underlying interleaved mutable buffer.

impl<T, const N: usize> AsInterleavedMut<T> for Interleaved<&mut [T; N]>

fn as_interleaved_mut(&mut self) -> &mut [T]

Access the underlying interleaved mutable buffer.

pub fn as_interleaved_mut_ptr(&mut self) -> *mut T

Access a pointer to the underlying interleaved mutable buffer.

impl<T> Buf for Interleaved<&[T]>

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.

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

Construct a new buffer where n frames are skipped.

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

Construct a new buffer where n frames are skipped.

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

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

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

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.

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

Construct a new buffer where n frames are skipped.

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

Construct a new buffer where n frames are skipped.

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

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

impl<T, const N: usize> Buf for Interleaved<[T; N]>

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.

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

Construct a new buffer where n frames are skipped.

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

Construct a new buffer where n frames are skipped.

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

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

impl<T, const N: usize> Buf for Interleaved<&[T; N]>

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.

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

Construct a new buffer where n frames are skipped.

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

Construct a new buffer where n frames are skipped.

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

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

impl<T, const N: usize> Buf for Interleaved<&mut [T; N]>

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.

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

Construct a new buffer where n frames are skipped.

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

Construct a new buffer where n frames are skipped.

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

Limit the channel buffer to limit number of frames.

pub fn chunk(self, n: usize, len: usize) -> Chunk<Self>

Construct a range of frames corresponds to the chunk with len and position n.

impl<T> Channels<T> for Interleaved<&[T]>

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

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

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

impl<T, const N: usize> Channels<T> for Interleaved<[T; N]>

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

impl<T, const N: usize> Channels<T> for Interleaved<&[T; N]>

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

impl<T, const N: usize> Channels<T> for Interleaved<&mut [T; N]>

fn channel(&self, channel: usize) -> Channel<'_, T>

Return a handler to the buffer associated with the channel.

impl<T> ChannelsMut<T> for Interleaved<&mut [T]> where
    T: Copy, 

fn channel_mut(&mut self, channel: usize) -> ChannelMut<'_, T>

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

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

Copy one channel into another.

impl<T, const N: usize> ChannelsMut<T> for Interleaved<&mut [T; N]> where
    T: Copy, 

fn channel_mut(&mut self, channel: usize) -> ChannelMut<'_, T>

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

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

Copy one channel into another.

impl<T> ExactSizeBuf for Interleaved<&[T]>

fn frames(&self) -> usize

The number of frames in a buffer.

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

fn frames(&self) -> usize

The number of frames in a buffer.

impl<T, const N: usize> ExactSizeBuf for Interleaved<[T; N]>

fn frames(&self) -> usize

The number of frames in a buffer.

impl<T, const N: usize> ExactSizeBuf for Interleaved<&[T; N]>

fn frames(&self) -> usize

The number of frames in a buffer.

impl<T, const N: usize> ExactSizeBuf for Interleaved<&mut [T; N]>

fn frames(&self) -> usize

The number of frames in a buffer.

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

fn reserve_frames(&mut self, frames: usize)

Make sure that the buffer has reserved exactly the given number of frames.

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

Set the buffer to have the given topology.

impl<T> ReadBuf for Interleaved<&[T]>

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.

pub fn has_remaining(&self) -> bool

Test if there are any remaining frames to read.

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

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.

pub fn has_remaining(&self) -> bool

Test if there are any remaining frames to read.

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

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.

pub fn has_remaining_mut(&self) -> bool

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