Skip to main content

LibId

Struct LibId 

Source
#[repr(transparent)]
pub struct LibId(pub u32);
Expand description

A type-safe, zero-cost wrapper for a cFE Library ID.

This is a lightweight, Copy-able handle that represents a unique loaded library. It can be used to query information about that specific library.

Tuple Fields§

§0: u32

Implementations§

Source§

impl LibId

Source

pub fn from_name(name: &str) -> Result<Self>

Retrieves the cFE Library ID for a given library name.

§Arguments
  • name: The registered name of the library to look up.
§Errors

Returns an error if no library with the given name is found.

Source

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

Retrieves the name for this library ID.

§Errors

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

Source

pub fn info(&self) -> Result<AppInfo>

Retrieves detailed information about the library with this ID.

Note: This reuses the AppInfo struct, as the underlying FFI type is the same. Fields related to tasks (e.g., MainTaskId) will not be meaningful for a library.

§Errors

Returns an error if the Lib ID is not valid or if the underlying CFE call fails.

Source

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

Converts the Lib ID into a zero-based integer suitable for array indexing.

§Errors

Returns an error if the Lib ID is not valid or if the underlying CFE call fails.

Trait Implementations§

Source§

impl Clone for LibId

Source§

fn clone(&self) -> LibId

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LibId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<LibId> for ResourceId

Source§

fn from(lib_id: LibId) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for LibId

Source§

fn eq(&self, other: &LibId) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for LibId

Source§

impl Eq for LibId

Source§

impl StructuralPartialEq for LibId

Auto Trait Implementations§

§

impl Freeze for LibId

§

impl RefUnwindSafe for LibId

§

impl Send for LibId

§

impl Sync for LibId

§

impl Unpin for LibId

§

impl UnsafeUnpin for LibId

§

impl UnwindSafe for LibId

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, 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.