Struct esp_idf_svc::hal::sys::i2s_event_callbacks_t

#[repr(C)]
pub struct i2s_event_callbacks_t {
    pub on_recv: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>,
    pub on_recv_q_ovf: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>,
    pub on_sent: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>,
    pub on_send_q_ovf: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>,
}

@brief Group of I2S callbacks @note The callbacks are all running under ISR environment @note When CONFIG_I2S_ISR_IRAM_SAFE is enabled, the callback itself and functions called by it should be placed in IRAM. The variables used in the function should be in the SRAM as well.

Fields

on_recv: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>

< Callback of data received event, only for RX channel The event data includes DMA buffer address and size that just finished receiving data

on_recv_q_ovf: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>

< Callback of receiving queue overflowed event, only for RX channel The event data includes buffer size that has been overwritten

on_sent: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>

< Callback of data sent event, only for TX channel The event data includes DMA buffer address and size that just finished sending data

on_send_q_ovf: Option<unsafe extern "C" fn(_: *mut i2s_channel_obj_t, _: *mut i2s_event_data_t, _: *mut c_void) -> bool>

< Callback of sending queue overflowed event, only for TX channel The event data includes buffer size that has been overwritten

Trait Implementations

impl Clone for i2s_event_callbacks_t

fn clone(&self) -> i2s_event_callbacks_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for i2s_event_callbacks_t

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

Formats the value using the given formatter.

impl Default for i2s_event_callbacks_t

fn default() -> i2s_event_callbacks_t

Returns the “default value” for a type.

impl Copy for i2s_event_callbacks_t