Enum BusTimeout

#[non_exhaustive]
pub enum BusTimeout {
    Maximum,
    Disabled,
    BusCycles(u32),
}

I2C SCL timeout period.

When the level of SCL remains unchanged for more than timeout bus clock cycles, the bus goes to idle state.

Default value is BusCycles(10).

Note that the effective timeout may be longer than the value configured here.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Maximum

Use the maximum timeout value.

Disabled

Disable timeout control.

BusCycles(u32)

Timeout in bus clock cycles.

Trait Implementations

impl Clone for BusTimeout

fn clone(&self) -> BusTimeout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BusTimeout

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

Formats the value using the given formatter.

impl Display for BusTimeout

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

Formats the value using the given formatter.

impl Format for BusTimeout

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Hash for BusTimeout

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 BusTimeout

fn eq(&self, other: &BusTimeout) -> 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 BusTimeout

impl Eq for BusTimeout

impl StructuralPartialEq for BusTimeout