Struct AppId 

pub struct AppId(/* private fields */);

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

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

Implementations

impl AppId

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

Retrieves detailed information about the application with this ID.

Errors

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

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

Retrieves the name for this application ID.

Errors

Returns an error if the App ID is not valid, the buffer is too small, or the name is not valid UTF-8.

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

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

Errors

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

pub fn restart(&self) -> Result<()>

Requests cFE to restart this application.

If the application file is missing or corrupt at restart time, the application may be permanently deleted and unrecoverable except via the ES_STARTAPP ground command.

Errors

Returns an error if the app_id is invalid or if the restart command fails.

pub fn reload(&self, filename: &str) -> Result<()>

Requests cFE to reload this application from a new file.

If the file is missing or corrupt, the application may be permanently deleted and unrecoverable except via the ES_STARTAPP ground command.

Arguments

• filename: The path to the new application binary file.

Errors

Returns an error if the app_id is invalid, the filename is invalid, the file cannot be accessed, or the reload command fails.

pub fn delete(&self) -> Result<()>

Requests cFE to delete this application.

Errors

Returns an error if the app_id is invalid or if the delete command fails.

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

Retrieves the cFE Application ID for a given application name.

Arguments

• name: The registered name of the application to look up.

Errors

Returns an error if no application with the given name is found, or if the name is too long for the internal CFE buffers.

pub fn this() -> Result<AppId>

Returns the ID of the currently running application.

Child tasks return the same application ID as their parent.

Errors

Returns an error if called from a context that is not a registered cFE application task.

impl AppId

pub fn send_event( &self, event_id: u16, event_type: EventType, message: &str, ) -> Result<()>

Sends a formatted software event that appears to originate from this application.

This allows a library or shared service to send an event on behalf of another application.

Errors

Returns an error if the underlying CFE_EVS_SendEventWithAppID call fails.

Methods from Deref<Target = u32>

pub const MIN: u32 = 0

pub const MAX: u32

pub const BITS: u32

Trait Implementations

impl Clone for AppId

fn clone(&self) -> AppId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AppId

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

Formats the value using the given formatter.

impl Deref for AppId

type Target = u32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<AppId> for ResourceId

fn from(app_id: AppId) -> Self

Converts to this type from the input type.

impl PartialEq for AppId

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

impl Eq for AppId

impl StructuralPartialEq for AppId