Struct WriteOptions

Source
pub struct WriteOptions { /* private fields */ }
Expand description

Options for writing audio files.

Implementations§

Source§

impl WriteOptions

Source

pub fn new( major_format: MajorFormat, subtype_format: SubtypeFormat, endian: Endian, samplerate: usize, channels: usize, ) -> Self

Create new WriteOptions.

  • major_format: Audio container format, e.g., SubtypeFormat::WAV, SubtypeFormat::FLAC, etc
  • subtype_format: Audio encoding format, e.g., SubtypeFormat::PCM_S16, SubtypeFormat::VORBIS, etc
  • endian: Usually Endian::File
  • samplerate: A positive number
  • channels: A positive number
Source

pub fn validate(self) -> Option<Self>

This function allows the caller to check if a set of parameters in the WriteOptions is valid.

Returns Some(Self) if the parameters are valid and None otherwise.

Trait Implementations§

Source§

impl Debug for WriteOptions

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.