Struct UnitConfig

#[non_exhaustive]
pub struct UnitConfig { /* private fields */ }

Available on crate feature unstable only.

I2S receiver/transmitter unit configuration

Implementations

impl UnitConfig

pub fn with_sample_rate(self, sample_rate: Rate) -> Self

Assign the given value to the sample_rate field.

pub fn sample_rate(&self) -> Rate

The target sample rate

pub fn with_channels(self, channels: Channels) -> Self

Assign the given value to the channels field.

pub fn channels(&self) -> Channels

I2S channels configuration

pub fn with_data_format(self, data_format: DataFormat) -> Self

Assign the given value to the data_format field.

pub fn data_format(&self) -> DataFormat

Format of the data

pub fn with_ws_width(self, ws_width: WsWidth) -> Self

Assign the given value to the ws_width field.

pub fn ws_width(&self) -> WsWidth

Duration for which WS signal is kept active

pub fn with_ws_polarity(self, ws_polarity: Polarity) -> Self

Assign the given value to the ws_polarity field.

pub fn ws_polarity(&self) -> Polarity

Polarity of WS signal

pub fn with_msb_shift(self, msb_shift: bool) -> Self

Assign the given value to the msb_shift field.

pub fn msb_shift(&self) -> bool

Data signal will lag by one bit relative to the WS signal

pub fn with_endianness(self, endianness: Endianness) -> Self

Assign the given value to the endianness field.

pub fn endianness(&self) -> Endianness

Byte order of the data

pub fn with_bit_order(self, bit_order: BitOrder) -> Self

Assign the given value to the bit_order field.

pub fn bit_order(&self) -> BitOrder

Bit order of the data

impl UnitConfig

pub fn new_tdm_philips() -> Self

TDM Philips standard configuration with two 16-bit active channels

pub fn new_tdm_msb() -> Self

TDM MSB standard configuration with two 16-bit active channels

pub fn new_tdm_pcm_short() -> Self

TDM PCM short frame standard configuration with two 16-bit active channels

pub fn new_tdm_pcm_long() -> Self

TDM PCM long frame standard configuration with two 16-bit active channels

Trait Implementations

impl Clone for UnitConfig

fn clone(&self) -> UnitConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnitConfig

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

Formats the value using the given formatter.

impl Default for UnitConfig

fn default() -> Self

Returns the “default value” for a type.

impl Hash for UnitConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl PartialEq for UnitConfig

fn eq(&self, other: &UnitConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for UnitConfig

impl Eq for UnitConfig

impl StructuralPartialEq for UnitConfig