Struct audio::wrap::Dynamic

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

A wrapper for an external dynamic audio buffer.

See wrap::dynamic.

Implementations

impl<T> Dynamic<T>

pub fn as_ref(&self) -> &T

Get a reference to the inner value.

Examples

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

pub fn as_mut(&mut self) -> &mut T

Get a mutable reference to the inner value.

Examples

let mut buf = audio::wrap::dynamic(vec![vec![1, 2, 3, 4]]);
*buf.as_mut() = vec![vec![5, 6, 7, 8]];
assert_eq!(buf.as_ref(), &[vec![5, 6, 7, 8]]);

pub fn into_inner(self) -> T

Get the inner wrapper value.

Examples

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

Trait Implementations

impl<T> Buf for Dynamic<&[Vec<T>]>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&[Vec<T>]> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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, const N: usize> Buf for Dynamic<&[Vec<T>; N]>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&[Vec<T>; N]> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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> Buf for Dynamic<&Vec<Vec<T>>>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&Vec<Vec<T>>> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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> Buf for Dynamic<&mut [Vec<T>]>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&mut [Vec<T>]> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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, const N: usize> Buf for Dynamic<&mut [Vec<T>; N]>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&mut [Vec<T>; N]> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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> Buf for Dynamic<&mut Vec<Vec<T>>>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<&mut Vec<Vec<T>>> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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, const N: usize> Buf for Dynamic<[Vec<T>; N]>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<[Vec<T>; N]> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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> Buf for Dynamic<Vec<Vec<T>>>

where T: Copy,

type Sample = T

The type of a single sample.

type Channel<'this> = LinearChannel<'this, <Dynamic<Vec<Vec<T>>> as Buf>::Sample> where Self: 'this

The type of the channel container.

type IterChannels<'this> = IterChannels<'this, T> 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 Dynamic<&mut [Vec<T>]>

where T: Copy,

type ChannelMut<'this> = LinearChannelMut<'this, T> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, T> 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, const N: usize> BufMut for Dynamic<&mut [Vec<T>; N]>

where T: Copy,

type ChannelMut<'this> = LinearChannelMut<'this, T> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, T> 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> BufMut for Dynamic<&mut Vec<Vec<T>>>

where T: Copy,

type ChannelMut<'this> = LinearChannelMut<'this, T> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, T> 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, const N: usize> BufMut for Dynamic<[Vec<T>; N]>

where T: Copy,

type ChannelMut<'this> = LinearChannelMut<'this, T> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, T> 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> BufMut for Dynamic<Vec<Vec<T>>>

where T: Copy,

type ChannelMut<'this> = LinearChannelMut<'this, T> where Self: 'this

The type of the mutable channel container.

type IterChannelsMut<'this> = IterChannelsMut<'this, T> 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> ResizableBuf for Dynamic<Vec<Vec<T>>>

where T: Sample,

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.