Struct sndfile::SndFile

pub struct SndFile { /* private fields */ }

Main struct of this crate.

Implementations

impl SndFile

pub fn get_samplerate(&self) -> usize

Get sample rate.

Return values should be greater than zero.

pub fn get_channels(&self) -> usize

Get channel count.

Return values should be greater than zero.

pub fn get_major_format(&self) -> MajorFormat

Get audio container format

pub fn get_subtype_format(&self) -> SubtypeFormat

Get audio encoding format

pub fn get_endian(&self) -> Endian

Get audio file endian

Usually returns Endian::File

pub fn is_seekable(&self) -> bool

Check if this file seekable

If not, many functions like len or read_all_to_vec will return an error.

pub fn get_raw_struct(&self) -> &UnsafeSndFile

Useful if you want to do something unsafe.

pub fn get_tag(&self, t: TagType) -> Option<String>

Get tag string, e.g., artist, album, etc.

pub fn set_tag(&mut self, t: TagType, v: &str) -> Result<(), SndFileError>

Set tag string

pub fn seek(&mut self, pos: SeekFrom) -> Result<u64, ()>

Modify the I/O cursor.

pub fn len(&mut self) -> Result<u64, ()>

Get the length of audio file.

This function may affect the I/O cursor.

Trait Implementations

impl Debug for SndFile

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

Formats the value using the given formatter.

impl SndFileIO<f32> for SndFile

fn read_to_slice(&mut self, dst: &mut [f32]) -> Result<usize, ()>

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_slice(&mut self, src: &[f32]) -> Result<usize, ()>

Read frames from file, returns the number of frames written if success.

fn read_all_to_vec(&mut self) -> Result<Vec<f32>, ()>

Read all frames into a Vec<_> if success.

fn read_to_iter<'a, I>(&mut self, dst: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = &'a mut T>, 

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_iter<'a, I>(&mut self, src: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = T>, 

Read frames from file, returns the number of frames written if success.

impl SndFileIO<f64> for SndFile

fn read_to_slice(&mut self, dst: &mut [f64]) -> Result<usize, ()>

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_slice(&mut self, src: &[f64]) -> Result<usize, ()>

Read frames from file, returns the number of frames written if success.

fn read_all_to_vec(&mut self) -> Result<Vec<f64>, ()>

Read all frames into a Vec<_> if success.

fn read_to_iter<'a, I>(&mut self, dst: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = &'a mut T>, 

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_iter<'a, I>(&mut self, src: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = T>, 

Read frames from file, returns the number of frames written if success.

impl SndFileIO<i16> for SndFile

fn read_to_slice(&mut self, dst: &mut [i16]) -> Result<usize, ()>

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_slice(&mut self, src: &[i16]) -> Result<usize, ()>

Read frames from file, returns the number of frames written if success.

fn read_all_to_vec(&mut self) -> Result<Vec<i16>, ()>

Read all frames into a Vec<_> if success.

fn read_to_iter<'a, I>(&mut self, dst: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = &'a mut T>, 

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_iter<'a, I>(&mut self, src: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = T>, 

Read frames from file, returns the number of frames written if success.

impl SndFileIO<i32> for SndFile

fn read_to_slice(&mut self, dst: &mut [i32]) -> Result<usize, ()>

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_slice(&mut self, src: &[i32]) -> Result<usize, ()>

Read frames from file, returns the number of frames written if success.

fn read_all_to_vec(&mut self) -> Result<Vec<i32>, ()>

Read all frames into a Vec<_> if success.

fn read_to_iter<'a, I>(&mut self, dst: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = &'a mut T>, 

Read frames from current I/O cursor, returns the number of frames read if success.

fn write_from_iter<'a, I>(&mut self, src: I) -> Result<usize, ()> where
    I: ExactSizeIterator<Item = T>, 

Read frames from file, returns the number of frames written if success.

impl SndFileNDArrayIO<f32> for SndFile

fn read_to_ndarray(&mut self, dst: ArrayViewMut2<'_, f32>) -> Result<usize, ()>

fn write_from_ndarray(&mut self, src: ArrayView2<'_, f32>) -> Result<usize, ()>

fn read_all_to_ndarray(&mut self) -> Result<Array2<f32>, ()>

impl SndFileNDArrayIO<f64> for SndFile

fn read_to_ndarray(&mut self, dst: ArrayViewMut2<'_, f64>) -> Result<usize, ()>

fn write_from_ndarray(&mut self, src: ArrayView2<'_, f64>) -> Result<usize, ()>

fn read_all_to_ndarray(&mut self) -> Result<Array2<f64>, ()>

impl SndFileNDArrayIO<i16> for SndFile

fn read_to_ndarray(&mut self, dst: ArrayViewMut2<'_, i16>) -> Result<usize, ()>

fn write_from_ndarray(&mut self, src: ArrayView2<'_, i16>) -> Result<usize, ()>

fn read_all_to_ndarray(&mut self) -> Result<Array2<i16>, ()>

impl SndFileNDArrayIO<i32> for SndFile

fn read_to_ndarray(&mut self, dst: ArrayViewMut2<'_, i32>) -> Result<usize, ()>

fn write_from_ndarray(&mut self, src: ArrayView2<'_, i32>) -> Result<usize, ()>

fn read_all_to_ndarray(&mut self) -> Result<Array2<i32>, ()>

impl Send for SndFile