Struct Channel 

#[non_exhaustive]
pub struct Channel<'ch, Dm, Dir>
where
    Dm: DriverMode,
    Dir: Direction,
{ /* private fields */ }

RMT Channel

Implementations

impl<Dm, Dir> Channel<'_, Dm, Dir>

where Dm: DriverMode, Dir: Direction,

pub fn reborrow<'a>(&'a mut self) -> Channel<'a, Dm, Dir>

Reborrow this channel for a shorter lifetime 'a.

impl<'ch, Dm> Channel<'ch, Dm, Tx>

where Dm: DriverMode,

pub fn with_pin(self, pin: impl PeripheralOutput<'ch>) -> Self

Connect a pin to the channel’s output signal.

This will replace previous pin assignments for this signal.

pub fn apply_config( &mut self, config: &TxChannelConfig, ) -> Result<(), ConfigError>

Change the configuration.

Errors

This function can return

• ConfigError::MemoryBlockNotAvailable,
• ConfigError::MemsizeOutOfRange.

impl<'ch, Dm> Channel<'ch, Dm, Rx>

where Dm: DriverMode,

pub fn with_pin(self, pin: impl PeripheralInput<'ch>) -> Self

Connect a pin to the channel’s input signal.

This will replace previous pin assignments for this signal.

pub fn apply_config( &mut self, config: &RxChannelConfig, ) -> Result<(), ConfigError>

Change the configuration.

Errors

This function can return

• ConfigError::MemoryBlockNotAvailable,
• ConfigError::MemsizeOutOfRange,
• ConfigError::IdleThresholdOutOfRange.

impl<'ch> Channel<'ch, Blocking, Tx>

Channel in TX mode

pub fn transmit<'data>( self, data: &'data [PulseCode], ) -> Result<TxTransaction<'ch, 'data>, (Error, Self)>

Start transmitting the given pulse code sequence. This returns a TxTransaction which can be used to wait for the transaction to complete and get back the channel for further use.

pub fn transmit_continuously( self, data: &[PulseCode], mode: LoopMode, ) -> Result<ContinuousTxTransaction<'ch>, (Error, Self)>

Start transmitting the given pulse code continuously.

This returns a ContinuousTxTransaction which can be used to stop the ongoing transmission and get back the channel for further use.

The mode argument determines whether transmission will continue until explicitly stopped or for a fixed number of iterations; see LoopMode for more details. When using a loop mode other than LoopMode::Infinite, ContinuousTxTransaction::is_loopcount_interrupt_set can be used to check if the loop count is reached. The length of data cannot exceed the size of the allocated RMT RAM.

impl<'ch> Channel<'ch, Blocking, Rx>

Channel is RX mode

pub fn receive<'data>( self, data: &'data mut [PulseCode], ) -> Result<RxTransaction<'ch, 'data>, (Error, Self)>

Start receiving pulse codes into the given buffer. This returns a RxTransaction which can be used to wait for receive to complete and get back the channel for further use.

impl Channel<'_, Async, Tx>

TX channel in async mode

pub fn transmit( &mut self, data: &[PulseCode], ) -> impl Future<Output = Result<(), Error>>

Start transmitting the given pulse code sequence.

impl Channel<'_, Async, Rx>

RX channel in async mode

pub fn receive( &mut self, data: &mut [PulseCode], ) -> impl Future<Output = Result<usize, Error>>

Start receiving a pulse code sequence.

Trait Implementations

impl<'ch, Dm, Dir> Debug for Channel<'ch, Dm, Dir>

where Dm: DriverMode + Debug, Dir: Direction + Debug,

Available on crate feature unstable only.

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

Formats the value using the given formatter.