Trait OsInterface

Source

pub trait OsInterface: Send + Sync {
    type RawMutex: ConstInit + RawMutex;
    type Notifier: Notifier;
    type NotifyWaiter: NotifyWaiter;
    type Timeout: TimeoutNs;

    // Required methods
    fn yield_thread();
    fn delay() -> impl DelayNs;
    fn notify() -> (Self::Notifier, Self::NotifyWaiter);

    // Provided method
    fn mutex<T>(d: T) -> Mutex<Self, T> { ... }
}

Expand description

Adapter for different operating systems.

We use the mutex-traits crate to provide mutex functionality. You need to select an appropriate mutex implementation based on your needs. And you can implement your own mutex by implementing the RawMutex trait from the mutex-traits crate.

use os_trait::{prelude::*, FakeOs, StdOs};

fn os_interface<OS: OsInterface>() {
    let mutex = OS::mutex(2);

    let mut guard = mutex.try_lock().unwrap();
    assert_eq!(*guard, 2);

    OS::yield_thread();
}

fn select_os() {
    os_interface::<FakeOs>();
    os_interface::<StdOs>();
}