Skip to main content

I2sRx

esp_hal::i2s::master

Struct I2sRx 

Source 
pub struct I2sRx<'d, Dm>
where
    Dm: DriverMode,
{ /* private fields */ }
Expand description

I2S RX channel.

Implementations§

Source§

impl<'d, Dm> I2sRx<'d, Dm>
where Dm: DriverMode,

Source

pub fn read<BUF>( self, buffer: BUF, ) -> Result<I2sRxDmaTransfer<'d, Dm, BUF>, (Error, Self, BUF)>
where BUF: DmaRxBuffer,

Performs a DMA read.

The number of read bytes might be less than the capacity of the provided buffer since the peripheral might not completely fill each descriptor’s buffer.

Returns an I2sRxDmaTransfer.

Source

pub fn apply_config( &mut self, rx_config: &UnitConfig, ) -> Result<(), ConfigError>

Changes the I2S Rx unit configuration.

Trait Implementations§

Source§

impl<Dm> Debug for I2sRx<'_, Dm>
where Dm: DriverMode,

Available on crate feature unstable only.
Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'d, Dm> !RefUnwindSafe for I2sRx<'d, Dm>

§

impl<'d, Dm> !UnwindSafe for I2sRx<'d, Dm>

§

impl<'d, Dm> Freeze for I2sRx<'d, Dm>
where ChannelRx<Dm, <AhbGdmaChannel<'d> as DmaChannel>::Rx>: Freeze,

§

impl<'d, Dm> Send for I2sRx<'d, Dm>
where ChannelRx<Dm, <AhbGdmaChannel<'d> as DmaChannel>::Rx>: Send,

§

impl<'d, Dm> Sync for I2sRx<'d, Dm>
where ChannelRx<Dm, <AhbGdmaChannel<'d> as DmaChannel>::Rx>: Sync,

§

impl<'d, Dm> Unpin for I2sRx<'d, Dm>
where ChannelRx<Dm, <AhbGdmaChannel<'d> as DmaChannel>::Rx>: Unpin,

§

impl<'d, Dm> UnsafeUnpin for I2sRx<'d, Dm>
where ChannelRx<Dm, <AhbGdmaChannel<'d> as DmaChannel>::Rx>: UnsafeUnpin,

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.