Api

wasefire_board_api

Trait Api 

Source 
pub trait Api: Send + 'static {

Show 17 associated items    type Applet: Api;
    type Button: Api;
    type Clock: Api;
    type Crypto: Api;
    type Debug: Api;
    type Fingerprint: Api;
    type Gpio: Api;
    type Led: Api;
    type Platform: Api;
    type Rng: Api;
    type Storage: Singleton + Storage + Send;
    type Timer: Api;
    type Uart: Api;
    type Usb: Api;
    type Vendor: Api;

    // Required methods
    fn try_event() -> Option<Event<Self>>;
    fn wait_event() -> Event<Self>;

}
Expand description

Board interface.

This is essentially a type hierarchy. The implementation is responsible for handling a possible explicit global state. The type implementing this API may be equivalent to the never type (e.g. an empty enum) because it is never used, i.e. there are no functions which take self.

Required Associated Types§

Source

type Applet: Api

Applet interface.

Source

type Button: Api

Available on crate feature api-button only.

Button interface.

Source

type Clock: Api

Available on crate feature api-clock only.

Clock interface.

Source

type Crypto: Api

Available on crate feature internal-api-crypto only.

Cryptography interface.

Source

type Debug: Api

Debugging and testing interface.

Source

type Fingerprint: Api

Available on crate feature internal-api-fingerprint only.

Fingerprint interface.

Source

type Gpio: Api

Available on crate feature api-gpio only.

Low-level GPIO interface.

Source

type Led: Api

Available on crate feature api-led only.

LED interface.

Source

type Platform: Api

Platform interface.

Source

type Rng: Api

Available on crate feature api-rng only.

Random number generator interface.

Source

type Storage: Singleton + Storage + Send

Available on crate feature api-storage only.

Persistent storage interface.

Source

type Timer: Api

Available on crate feature api-timer only.

Timer interface.

Source

type Uart: Api

Available on crate feature api-uart only.

UART interface.

Source

type Usb: Api

Available on crate feature internal-api-usb only.

USB interface.

Source

type Vendor: Api

Available on crate feature api-vendor only.

Vendor interface.

Required Methods§

Source

fn try_event() -> Option<Event<Self>>

Returns the oldest triggered event, if any.

This function is non-blocking. See Self::wait_event() for a blocking version.

Source

fn wait_event() -> Event<Self>

Returns the oldest triggered event, possibly waiting until one triggers.

This function is non-blocking if an event already triggered. However, if there are no event available, this function blocks and enters a power-saving state until an event triggers.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§