Struct Channels 

pub struct Channels { /* private fields */ }

I2S channels configuration

Implementations

impl Channels

pub const STEREO: Channels

Two channels will use different data

pub const MONO: Channels

Two channels will use the same data

pub const LEFT: Channels

Two channels. Left(first) channel will contain data. Right(second) channel will contain zeros.

pub const RIGHT: Channels

Two channels. Right(second) channel will contain data. Left(first) channel will contain zeros.

pub const fn new(count: u8, mask: u16, fill: Option<u32>) -> Self

Creates arbitrary configuration for I2S channels.

• count the total number of channels. Must be at least 1 and no more than 16.
• mask determines which channels will be active, with the least significant bit representing first channel. Setting the bit at the nth position means nth channel is active. Inactive channels do not consume or write data in the DMA buffer.
• fill determines the behavior of inactive channels. Some(n) will make all inactive channel send out specified value, truncated to the channel width. None will make disabled channels repeat the data from the last active channel. This field is ignored in the receiver unit.

Example

The following example prepares configuration for 6 channels. Only 1st and 4th channels are active. Channels 2-3 will use the same data as the 1st, and channels 5-6 will use the data from the 4th.

use esp_hal::i2s::master::Channels;

let channels = Channels::new(6, 0b_001_001, None);

Trait Implementations

impl Clone for Channels

Available on crate feature unstable only.

fn clone(&self) -> Channels

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Channels

Available on crate feature unstable only.

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

Formats the value using the given formatter.

impl Hash for Channels

Available on crate feature unstable only.

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 Channels

Available on crate feature unstable only.

fn eq(&self, other: &Channels) -> 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 Channels

Available on crate feature unstable only.

impl Eq for Channels

Available on crate feature unstable only.

impl StructuralPartialEq for Channels

Available on crate feature unstable only.