Struct OsalId 

#[repr(transparent)]
pub struct OsalId(pub u32);

A generic, type-safe wrapper for an OSAL object ID.

Tuple Fields

0: u32

Implementations

impl OsalId

pub fn name(&self) -> Result<String<{ _ }>>

Retrieves the name of this OSAL object.

Errors

Returns an error if the object ID is invalid, the buffer is too small (unlikely with heapless), or the name is not valid UTF-8.

pub fn object_type(&self) -> ObjectType

Identifies the type of this OSAL object.

pub fn to_index(&self) -> Result<u32>

Converts this abstract ID into a zero-based integer suitable for use as an array index.

This does NOT verify that the ID refers to a currently valid or active resource — it only performs the numeric conversion.

pub fn to_index_as_type(&self, obj_type: ObjectType) -> Result<u32>

Converts this abstract ID of a specific type into a zero-based integer.

Errors

Returns Error::OsErrInvalidId if this ID is not of the specified obj_type or does not map to a valid index.

Trait Implementations

impl Clone for OsalId

fn clone(&self) -> OsalId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OsalId

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

Formats the value using the given formatter.

impl From<u32> for OsalId

fn from(id: u32) -> Self

Converts to this type from the input type.

impl PartialEq for OsalId

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

impl Eq for OsalId

impl StructuralPartialEq for OsalId