Struct esp_idf_sys::rmt_encoder_t

source ·
#[repr(C)]
pub struct rmt_encoder_t { pub encode: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t, tx_channel: rmt_channel_handle_t, primary_data: *const c_void, data_size: usize, ret_state: *mut rmt_encode_state_t) -> usize>, pub reset: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t) -> esp_err_t>, pub del: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t) -> esp_err_t>, }
Expand description

@brief Interface of RMT encoder

Fields§

§encode: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t, tx_channel: rmt_channel_handle_t, primary_data: *const c_void, data_size: usize, ret_state: *mut rmt_encode_state_t) -> usize>

@brief Encode the user data into RMT symbols and write into RMT memory

@note The encoding function will also be called from an ISR context, thus the function must not call any blocking API. @note It’s recommended to put this function implementation in the IRAM, to achieve a high performance and less interrupt latency.

@param[in] encoder Encoder handle @param[in] tx_channel RMT TX channel handle, returned from rmt_new_tx_channel() @param[in] primary_data App data to be encoded into RMT symbols @param[in] data_size Size of primary_data, in bytes @param[out] ret_state Returned current encoder’s state @return Number of RMT symbols that the primary data has been encoded into

§reset: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t) -> esp_err_t>

@brief Reset encoding state

@param[in] encoder Encoder handle @return - ESP_OK: reset encoder successfully - ESP_FAIL: reset encoder failed

§del: Option<unsafe extern "C" fn(encoder: *mut rmt_encoder_t) -> esp_err_t>

@brief Delete encoder object

@param[in] encoder Encoder handle @return - ESP_OK: delete encoder successfully - ESP_FAIL: delete encoder failed

Trait Implementations§

source§

impl Clone for rmt_encoder_t

source§

fn clone(&self) -> rmt_encoder_t

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for rmt_encoder_t

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for rmt_encoder_t

source§

fn default() -> rmt_encoder_t

Returns the “default value” for a type. Read more
source§

impl Copy for rmt_encoder_t

Auto Trait Implementations§

§

impl Freeze for rmt_encoder_t

§

impl RefUnwindSafe for rmt_encoder_t

§

impl Send for rmt_encoder_t

§

impl Sync for rmt_encoder_t

§

impl Unpin for rmt_encoder_t

§

impl UnwindSafe for rmt_encoder_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> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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.