Struct MonoView 

pub struct MonoView<'a, S: Sample> { /* private fields */ }

A read-only view of mono (single-channel) audio data.

This provides a lightweight, non-owning reference to a slice of mono audio samples.

• Layout: [sample0, sample1, sample2, ...]
• Interpretation: A simple sequence of samples representing a single audio channel.
• Usage: Ideal for mono audio processing, side-chain signals, or any single-channel audio data.

Example

use audio_blocks::{mono::MonoView, AudioBlock};

let data = vec![0.0, 1.0, 2.0, 3.0, 4.0];
let block = MonoView::from_slice(&data);

assert_eq!(block.sample(0), 0.0);
assert_eq!(block.sample(4), 4.0);
assert_eq!(block.num_frames(), 5);

Implementations

impl<'a, S: Sample> MonoView<'a, S>

pub fn from_slice(data: &'a [S]) -> Self

Creates a new mono audio block view from a slice of audio samples.

Parameters

• data - The slice containing mono audio samples

Example

use audio_blocks::{mono::MonoView, AudioBlock};

let samples = [1.0, 2.0, 3.0, 4.0, 5.0];
let block = MonoView::from_slice(&samples);
assert_eq!(block.num_frames(), 5);

pub fn from_slice_limited( data: &'a [S], num_frames_visible: usize, num_frames_allocated: usize, ) -> Self

Creates a new mono audio block view from a slice with limited visibility.

This function allows creating a view that exposes only a subset of the allocated frames, which is useful for working with a logical section of a larger buffer.

Parameters

• data - The slice containing mono audio samples
• num_frames_visible - Number of audio frames to expose in the view
• num_frames_allocated - Total number of frames allocated in the data buffer

Panics

• Panics if the length of data doesn’t equal num_frames_allocated
• Panics if num_frames_visible exceeds num_frames_allocated

Example

use audio_blocks::{mono::MonoView, AudioBlock};

let samples = [1.0, 2.0, 3.0, 4.0, 5.0];
let block = MonoView::from_slice_limited(&samples, 3, 5);
assert_eq!(block.num_frames(), 3);
assert_eq!(block.num_frames_allocated(), 5);

pub unsafe fn from_ptr(ptr: *const S, num_frames: usize) -> Self

Creates a new mono audio block view from a pointer.

Safety

The caller must ensure that:

• ptr points to valid memory containing at least num_frames elements
• The memory referenced by ptr must be valid for the lifetime of the returned view
• The memory must not be mutated through other pointers while this view exists

Example

use audio_blocks::{mono::MonoView, AudioBlock};

let samples = [1.0, 2.0, 3.0, 4.0, 5.0];
let block = unsafe { MonoView::from_ptr(samples.as_ptr(), 5) };
assert_eq!(block.num_frames(), 5);

pub unsafe fn from_ptr_limited( ptr: *const S, num_frames_visible: usize, num_frames_allocated: usize, ) -> Self

Creates a new mono audio block view from a pointer with limited visibility.

Safety

The caller must ensure that:

• ptr points to valid memory containing at least num_frames_allocated elements
• The memory referenced by ptr must be valid for the lifetime of the returned view
• The memory must not be mutated through other pointers while this view exists

pub fn sample(&self, frame: usize) -> S

Returns the sample at the specified frame index.

Panics

Panics if frame index is out of bounds.

pub fn samples(&self) -> &[S]

Provides direct access to the underlying samples as a slice.

Returns only the visible samples (up to num_frames).

pub fn raw_data(&self) -> &[S]

Provides direct access to all allocated memory, including reserved capacity.

pub fn view(&self) -> MonoView<'_, S>

Trait Implementations

impl<S: Sample> AudioBlock<S> for MonoView<'_, S>

type PlanarView = [S; 0]

fn num_channels(&self) -> u16

Returns the number of active audio channels.

fn num_frames(&self) -> usize

Returns the number of audio frames (samples per channel).

fn num_channels_allocated(&self) -> u16

Returns the total number of channels allocated in memory.

fn num_frames_allocated(&self) -> usize

Returns the total number of frames allocated in memory.

fn layout(&self) -> BlockLayout

Returns the memory layout of this audio block (interleaved, sequential, or planar).

fn sample(&self, channel: u16, frame: usize) -> S

Returns the sample value at the specified channel and frame position.

fn channel_iter(&self, channel: u16) -> impl ExactSizeIterator<Item = &S>

Returns an iterator over all samples in the specified channel.

fn channels_iter( &self, ) -> impl ExactSizeIterator<Item = impl ExactSizeIterator<Item = &S>>

Returns an iterator that yields an iterator for each channel.

fn frame_iter(&self, frame: usize) -> impl ExactSizeIterator<Item = &S>

Returns an iterator over all samples in the specified frame (across all channels).

fn frames_iter( &self, ) -> impl ExactSizeIterator<Item = impl ExactSizeIterator<Item = &S>>

Returns an iterator that yields an iterator for each frame.

fn as_view(&self) -> impl AudioBlock<S>

Creates a non-owning view of this audio block.

fn as_interleaved_view(&self) -> Option<InterleavedView<'_, S>>

Attempts to downcast this generic audio block to a concrete interleaved view. This enables access to frame slices and the underlying raw data.

fn as_planar_view(&self) -> Option<PlanarView<'_, S, Self::PlanarView>>

Attempts to downcast this generic audio block to a concrete planar view. This enables access to frame slices and the underlying raw data.

fn as_sequential_view(&self) -> Option<SequentialView<'_, S>>

Attempts to downcast this generic audio block to a concrete sequential view. This enables access to frame slices and the underlying raw data.

impl<S: Sample + Debug> Debug for MonoView<'_, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.