Enum SoftwareTimeout

pub enum SoftwareTimeout {
    None,
    Transaction(Duration),
    PerByte(Duration),
}

Available on crate feature unstable only.

Software timeout for I2C operations.

This timeout is used to limit the duration of I2C operations in software. Note that using this in conjunction with async operations will cause the task to be woken up continuously until the operation completes or the timeout is reached. You should prefer using an asynchronous timeout mechanism (like embassy_time::with_timeout) for better efficiency.

Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Variants

None

No software timeout is set.

Transaction(Duration)

Define a fixed timeout for I2C operations.

PerByte(Duration)

Define a data length dependent timeout for I2C operations.

The applied timeout is calculated as data_length * duration_per_byte. In I2c::transaction and I2c::transaction_async, the timeout is applied separately for each operation.

Trait Implementations

impl Clone for SoftwareTimeout

fn clone(&self) -> SoftwareTimeout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoftwareTimeout

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

Formats the value using the given formatter.

impl Hash for SoftwareTimeout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl PartialEq for SoftwareTimeout

fn eq(&self, other: &SoftwareTimeout) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SoftwareTimeout

impl Eq for SoftwareTimeout

impl StructuralPartialEq for SoftwareTimeout