Struct esp_idf_sys::spi_transaction_t

source ·
#[repr(C)]
pub struct spi_transaction_t { pub flags: u32, pub cmd: u16, pub addr: u64, pub length: usize, pub rxlength: usize, pub user: *mut c_void, pub __bindgen_anon_1: spi_transaction_t__bindgen_ty_1, pub __bindgen_anon_2: spi_transaction_t__bindgen_ty_2, }
Expand description

This structure describes one SPI transaction. The descriptor should not be modified until the transaction finishes.

Fields§

§flags: u32

< Bitwise OR of SPI_TRANS_* flags

§cmd: u16

< Command data, of which the length is set in the command_bits of spi_device_interface_config_t.

NOTE: this field, used to be “command” in ESP-IDF 2.1 and before, is re-written to be used in a new way in ESP-IDF 3.0.

Example: write 0x0123 and command_bits=12 to send command 0x12, 0x3_ (in previous version, you may have to write 0x3_12).

§addr: u64

< Address data, of which the length is set in the address_bits of spi_device_interface_config_t.

NOTE: this field, used to be “address” in ESP-IDF 2.1 and before, is re-written to be used in a new way in ESP-IDF3.0.

Example: write 0x123400 and address_bits=24 to send address of 0x12, 0x34, 0x00 (in previous version, you may have to write 0x12340000).

§length: usize

< Total data length, in bits

§rxlength: usize

< Total data length received, should be not greater than length in full-duplex mode (0 defaults this to the value of length).

§user: *mut c_void

< User-defined variable. Can be used to store eg transaction ID.

§__bindgen_anon_1: spi_transaction_t__bindgen_ty_1§__bindgen_anon_2: spi_transaction_t__bindgen_ty_2

Trait Implementations§

source§

impl Clone for spi_transaction_t

source§

fn clone(&self) -> spi_transaction_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 Default for spi_transaction_t

source§

fn default() -> Self

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

impl Copy for spi_transaction_t

Auto Trait Implementations§

§

impl Freeze for spi_transaction_t

§

impl RefUnwindSafe for spi_transaction_t

§

impl !Send for spi_transaction_t

§

impl !Sync for spi_transaction_t

§

impl Unpin for spi_transaction_t

§

impl UnwindSafe for spi_transaction_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.