Skip to main content

HAL

Struct HAL 

Source
pub struct HAL { /* private fields */ }
Expand description

A struct that defines a platform specific HAL(Hardware Abstraction Layer) using a Driver.

Using a HAL allows for significant platform changes without having to rewrite much code. HALs are also useful for testing/sim as they can be mocked.

HALs also allow for easier community support for exotic platforms.

Implementations§

Source§

impl HAL

Source

pub fn init<Driver: HALDriver>()

Initializes the HAL, can only be called once across every HAL.

§Panics

If HAL has already been initialized this will panic If the used driver is not zero sized this will panic

Source

pub fn init_sim<Driver: SimHALDriver>()

Initializes the HAL with support for sim, can only be called once across every HAL.

§Panics

If HAL has already been initialized this will panic. If the used driver is not zero sized this will panic.

Source

pub fn cleanup(&self)

Cleans up the HAL

Source

pub const fn driver_name(&self) -> &'static str

Returns the name of the current HALDriver.

Source

pub const fn notifier_api(&self) -> NotifierVTable

Returns the NotifierVTable for the current HALDriver.

Source

pub const fn watchdog_api(&self) -> WatchdogVTable

Returns the WatchdogVTable for the current HALDriver.

Source

pub const fn gpio_api(&self) -> GPIOVTable

Returns the GPIOVTable for the current HALDriver.

Source

pub const fn station_interface_api(&self) -> StationInterfaceVTable

Returns the StationInterfaceVTable for the current HALDriver.

Trait Implementations§

Source§

impl Clone for HAL

Source§

fn clone(&self) -> HAL

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for HAL

Source§

impl Debug for HAL

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for HAL

§

impl RefUnwindSafe for HAL

§

impl Send for HAL

§

impl Sync for HAL

§

impl Unpin for HAL

§

impl UnsafeUnpin for HAL

§

impl UnwindSafe for HAL

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.