SingleShotTxTransaction

esp_hal::rmt

Struct SingleShotTxTransaction 

Source 
pub struct SingleShotTxTransaction<'ch, 'data, T>
where
    T: Into<PulseCode> + Copy,
{ /* private fields */ }
Expand description

An in-progress transaction for a single shot TX transaction.

If the data size exceeds the size of the internal buffer, .poll() or .wait() needs to be called before the entire buffer has been sent to avoid underruns.

Implementations§

Source§

impl<'ch, T> SingleShotTxTransaction<'ch, '_, T>
where T: Into<PulseCode> + Copy,

Source

pub fn poll(&mut self) -> bool

Check transmission status and write new data to the hardware if necessary.

Returns whether transmission has ended (whether successfully or with an error). In that case, a subsequent call to wait() returns immediately.

Source

pub fn wait( self, ) -> Result<Channel<'ch, Blocking, Tx>, (Error, Channel<'ch, Blocking, Tx>)>

Wait for the transaction to complete

Trait Implementations§

Source§

impl<T> Drop for SingleShotTxTransaction<'_, '_, T>
where T: Into<PulseCode> + Copy,

Available on crate feature unstable only.
Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'ch, 'data, T> Freeze for SingleShotTxTransaction<'ch, 'data, T>

§

impl<'ch, 'data, T> RefUnwindSafe for SingleShotTxTransaction<'ch, 'data, T>
where T: RefUnwindSafe,

§

impl<'ch, 'data, T> Send for SingleShotTxTransaction<'ch, 'data, T>
where T: Sync,

§

impl<'ch, 'data, T> Sync for SingleShotTxTransaction<'ch, 'data, T>
where T: Sync,

§

impl<'ch, 'data, T> Unpin for SingleShotTxTransaction<'ch, 'data, T>

§

impl<'ch, 'data, T> !UnwindSafe for SingleShotTxTransaction<'ch, 'data, T>

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 = Infallible

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

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

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.