Enum OsalRsBool 

#[repr(u8)]
pub enum OsalRsBool {
    False = 1,
    True = 0,
}

Boolean type compatible with RTOS return values.

Many RTOS functions return 0 for success and non-zero for failure. This type provides a Rust-idiomatic way to work with such values.

Examples

use osal_rs::os::{Semaphore, SemaphoreFn};
use osal_rs::utils::OsalRsBool;
use core::time::Duration;
 
let sem = Semaphore::new(1, 1).unwrap();
 
match sem.wait(Duration::from_millis(100)) {
    OsalRsBool::True => println!("Acquired semaphore"),
    OsalRsBool::False => println!("Failed to acquire"),
}
 
// Can also convert to bool
if sem.signal().into() {
    println!("Semaphore signaled");
}

Variants

False = 1

Operation failed or condition is false

True = 0

Operation succeeded or condition is true

Trait Implementations

impl Clone for OsalRsBool

fn clone(&self) -> OsalRsBool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OsalRsBool

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

Formats the value using the given formatter.

impl PartialEq for OsalRsBool

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

impl Eq for OsalRsBool

impl StructuralPartialEq for OsalRsBool