Struct esp_idf_sys::rmt_encoder_t

#[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>,
}

@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

impl Clone for rmt_encoder_t

fn clone(&self) -> rmt_encoder_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for rmt_encoder_t

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

Formats the value using the given formatter.

impl Default for rmt_encoder_t

fn default() -> rmt_encoder_t

Returns the “default value” for a type.

impl Copy for rmt_encoder_t