[][src]Module esp32_hal::prelude

The prelude.

To use the esp32_hal effectively, a lot of traits and types need to be imported. Instead of importing them one by one manually, the prelude contains the most commonly used imports that are used around application runtime management.

This can be imported as use esp32_hal::prelude::*.

Re-exports

pub use crate::analog::SensExt;
pub use crate::dport;
pub use crate::dport::Peripheral;
pub use crate::gpio::GpioExt;
pub use crate::interrupt;
pub use crate::units::*;

Modules

exception

Exception handling

Structs

CriticalSectionSpinLockMutex

A spinlock and critical section section based mutex.

Traits

Cancel

Trait for cancelable countdowns.

CountDown

A count down timer

Mutex

Any object implementing this trait guarantees exclusive access to the data contained within the mutex for the duration of the lock.

Periodic

Marker trait that indicates that a timer is periodic

TupleExt01

Auto-generated tuple implementation, see Mutex for details.

TupleExt02

Auto-generated tuple implementation, see Mutex for details.

TupleExt03

Auto-generated tuple implementation, see Mutex for details.

TupleExt04

Auto-generated tuple implementation, see Mutex for details.

TupleExt05

Auto-generated tuple implementation, see Mutex for details.

TupleExt06

Auto-generated tuple implementation, see Mutex for details.

TupleExt07

Auto-generated tuple implementation, see Mutex for details.

TupleExt08

Auto-generated tuple implementation, see Mutex for details.

TupleExt09

Auto-generated tuple implementation, see Mutex for details.

TupleExt10

Auto-generated tuple implementation, see Mutex for details.

TupleExt11

Auto-generated tuple implementation, see Mutex for details.

TupleExt12

Auto-generated tuple implementation, see Mutex for details.

_

Single digital input pin

_

Single digital push-pull output pin

_

Push-pull output pin that can read its output state

_

Output pin that can be toggled

_embedded_hal_Capture

Input capture

_embedded_hal_Pwm

Pulse Width Modulation

_embedded_hal_PwmPin

A single PWM channel / pin

_embedded_hal_Qei

Quadrature encoder interface

_embedded_hal_adc_OneShot

ADCs that sample on single channels per request, and do so at the time of the request.

_embedded_hal_blocking_delay_DelayMs

Millisecond delay

_embedded_hal_blocking_delay_DelayUs

Microsecond delay

_embedded_hal_blocking_i2c_Read

Blocking read

_embedded_hal_blocking_i2c_Write

Blocking write

_embedded_hal_blocking_i2c_WriteRead

Blocking write + read

_embedded_hal_blocking_rng_Read

Blocking read

_embedded_hal_blocking_serial_Write

Write half of a serial interface (blocking variant)

_embedded_hal_blocking_spi_Transfer

Blocking transfer

_embedded_hal_blocking_spi_Write

Blocking write

_embedded_hal_digital_InputPinDeprecated

Single digital input pin

_embedded_hal_digital_OutputPinDeprecated

Single digital push-pull output pin

_embedded_hal_digital_ToggleableOutputPinDeprecated

Output pin that can be toggled

_embedded_hal_serial_Read

Read half of a serial interface

_embedded_hal_serial_Write

Write half of a serial interface

_embedded_hal_spi_FullDuplex

Full duplex (master mode)

_embedded_hal_timer_CountDown

A count down timer

_embedded_hal_watchdog_Watchdog

Feeds an existing watchdog to ensure the processor isn't reset. Sometimes commonly referred to as "kicking" or "refreshing".

_embedded_hal_watchdog_WatchdogDisable

Disables a running watchdog timer so the processor won't be reset.

_embedded_hal_watchdog_WatchdogEnable

Enables A watchdog timer to reset the processor if software is frozen or stalled.

Attribute Macros

entry

Marks a function as the main function to be called on program start

exception

Marks a function as the exception handler

interrupt

Marks a function as an interrupt handler

ram

This attribute allows placing statics, constants and functions into ram.