Enum r3::kernel::ResultCode

#[repr(i8)]
pub enum ResultCode {
    Success,
    NotSupported,
    BadParam,
    BadId,
    BadContext,
    NotOwner,
    WouldDeadlock,
    BadObjectState,
    QueueOverflow,
    Abandoned,
    Interrupted,
    Timeout,
}

All result codes (including success) that the C API can return.

Relation to Other Specifications: All error codes are intentionally matched to their equivalents in μITRON4.0 for no particular reasons.

Rationale: Using the C API result codes internally reduces the interop overhead at an API surface.

Variants

Success

The operation was successful. No additional information is available.

NotSupported

The operation is not supported.

BadParam

A parameter is invalid in a way that is no covered by any other error codes.

BadId

A specified object identifier (Id) is invalid.

BadContext

The current context disallows the operation.

NotOwner

The caller does not own the resource.

WouldDeadlock

Resource deadlock would occur.

BadObjectState

A target object is in a state that disallows the operation.

QueueOverflow

An operation or an object couldn’t be enqueued because there are too many of such things that already have been enqueued.

Abandoned

The owner of a mutex exited while holding the mutex lock.

Interrupted

The wait operation was interrupted by Task::interrupt.

Timeout

The operation timed out.

Implementations

impl ResultCode

pub fn as_str(self) -> &'static str

Get the short name of the result code.

Examples

use r3::kernel::ResultCode;
assert_eq!(ResultCode::BadObjectState.as_str(), "BadObjectState");

impl ResultCode

pub fn is_err(self) -> bool

Get a flag indicating whether the code represents a failure.

Failure codes have negative values.

pub fn is_ok(self) -> bool

Get a flag indicating whether the code represents a success.

Success codes have non-negative values.

Trait Implementations

impl Clone for ResultCode

fn clone(&self) -> ResultCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResultCode

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

Formats the value using the given formatter.

impl From<ActivateTaskError> for ResultCode

fn from(x: ActivateTaskError) -> Self

Performs the conversion.

impl From<AdjustTimeError> for ResultCode

fn from(x: AdjustTimeError) -> Self

Performs the conversion.

impl From<BoostPriorityError> for ResultCode

fn from(x: BoostPriorityError) -> Self

Performs the conversion.

impl From<ClearInterruptLineError> for ResultCode

fn from(x: ClearInterruptLineError) -> Self

Performs the conversion.

impl From<CpuLockError> for ResultCode

fn from(x: CpuLockError) -> Self

Performs the conversion.

impl From<DrainSemaphoreError> for ResultCode

fn from(x: DrainSemaphoreError) -> Self

Performs the conversion.

impl From<EnableInterruptLineError> for ResultCode

fn from(x: EnableInterruptLineError) -> Self

Performs the conversion.

impl From<ExitTaskError> for ResultCode

fn from(x: ExitTaskError) -> Self

Performs the conversion.

impl From<GetCurrentTaskError> for ResultCode

fn from(x: GetCurrentTaskError) -> Self

Performs the conversion.

impl From<GetEventGroupError> for ResultCode

fn from(x: GetEventGroupError) -> Self

Performs the conversion.

impl From<GetSemaphoreError> for ResultCode

fn from(x: GetSemaphoreError) -> Self

Performs the conversion.

impl From<GetTaskPriorityError> for ResultCode

fn from(x: GetTaskPriorityError) -> Self

Performs the conversion.

impl From<InterruptTaskError> for ResultCode

fn from(x: InterruptTaskError) -> Self

Performs the conversion.

impl From<LockMutexError> for ResultCode

fn from(x: LockMutexError) -> Self

Performs the conversion.

impl From<LockMutexTimeoutError> for ResultCode

fn from(x: LockMutexTimeoutError) -> Self

Performs the conversion.

impl From<MarkConsistentMutexError> for ResultCode

fn from(x: MarkConsistentMutexError) -> Self

Performs the conversion.

impl From<ParkError> for ResultCode

fn from(x: ParkError) -> Self

Performs the conversion.

impl From<ParkTimeoutError> for ResultCode

fn from(x: ParkTimeoutError) -> Self

Performs the conversion.

impl From<PendInterruptLineError> for ResultCode

fn from(x: PendInterruptLineError) -> Self

Performs the conversion.

impl From<PollEventGroupError> for ResultCode

fn from(x: PollEventGroupError) -> Self

Performs the conversion.

impl From<PollSemaphoreError> for ResultCode

fn from(x: PollSemaphoreError) -> Self

Performs the conversion.

impl From<QueryInterruptLineError> for ResultCode

fn from(x: QueryInterruptLineError) -> Self

Performs the conversion.

impl From<QueryMutexError> for ResultCode

fn from(x: QueryMutexError) -> Self

Performs the conversion.

impl From<Result<(), ActivateTaskError>> for ResultCode

fn from(x: Result<(), ActivateTaskError>) -> Self

Performs the conversion.

impl From<Result<(), AdjustTimeError>> for ResultCode

fn from(x: Result<(), AdjustTimeError>) -> Self

Performs the conversion.

impl From<Result<(), BadContextError>> for ResultCode

fn from(x: Result<(), BadContextError>) -> Self

Performs the conversion.

impl From<Result<(), BadIdError>> for ResultCode

fn from(x: Result<(), BadIdError>) -> Self

Performs the conversion.

impl From<Result<(), BadObjectStateError>> for ResultCode

fn from(x: Result<(), BadObjectStateError>) -> Self

Performs the conversion.

impl From<Result<(), BadParamError>> for ResultCode

fn from(x: Result<(), BadParamError>) -> Self

Performs the conversion.

impl From<Result<(), BoostPriorityError>> for ResultCode

fn from(x: Result<(), BoostPriorityError>) -> Self

Performs the conversion.

impl From<Result<(), ClearInterruptLineError>> for ResultCode

fn from(x: Result<(), ClearInterruptLineError>) -> Self

Performs the conversion.

impl From<Result<(), CpuLockError>> for ResultCode

fn from(x: Result<(), CpuLockError>) -> Self

Performs the conversion.

impl From<Result<(), DrainSemaphoreError>> for ResultCode

fn from(x: Result<(), DrainSemaphoreError>) -> Self

Performs the conversion.

impl From<Result<(), EnableInterruptLineError>> for ResultCode

fn from(x: Result<(), EnableInterruptLineError>) -> Self

Performs the conversion.

impl From<Result<(), ExitTaskError>> for ResultCode

fn from(x: Result<(), ExitTaskError>) -> Self

Performs the conversion.

impl From<Result<(), GetCurrentTaskError>> for ResultCode

fn from(x: Result<(), GetCurrentTaskError>) -> Self

Performs the conversion.

impl From<Result<(), GetEventGroupError>> for ResultCode

fn from(x: Result<(), GetEventGroupError>) -> Self

Performs the conversion.

impl From<Result<(), GetSemaphoreError>> for ResultCode

fn from(x: Result<(), GetSemaphoreError>) -> Self

Performs the conversion.

impl From<Result<(), GetTaskPriorityError>> for ResultCode

fn from(x: Result<(), GetTaskPriorityError>) -> Self

Performs the conversion.

impl From<Result<(), InterruptTaskError>> for ResultCode

fn from(x: Result<(), InterruptTaskError>) -> Self

Performs the conversion.

impl From<Result<(), LockMutexError>> for ResultCode

fn from(x: Result<(), LockMutexError>) -> Self

Performs the conversion.

impl From<Result<(), LockMutexPrecheckError>> for ResultCode

fn from(x: Result<(), LockMutexPrecheckError>) -> Self

Performs the conversion.

impl From<Result<(), LockMutexTimeoutError>> for ResultCode

fn from(x: Result<(), LockMutexTimeoutError>) -> Self

Performs the conversion.

impl From<Result<(), MarkConsistentMutexError>> for ResultCode

fn from(x: Result<(), MarkConsistentMutexError>) -> Self

Performs the conversion.

impl From<Result<(), ParkError>> for ResultCode

fn from(x: Result<(), ParkError>) -> Self

Performs the conversion.

impl From<Result<(), ParkTimeoutError>> for ResultCode

fn from(x: Result<(), ParkTimeoutError>) -> Self

Performs the conversion.

impl From<Result<(), PendInterruptLineError>> for ResultCode

fn from(x: Result<(), PendInterruptLineError>) -> Self

Performs the conversion.

impl From<Result<(), PollEventGroupError>> for ResultCode

fn from(x: Result<(), PollEventGroupError>) -> Self

Performs the conversion.

impl From<Result<(), PollSemaphoreError>> for ResultCode

fn from(x: Result<(), PollSemaphoreError>) -> Self

Performs the conversion.

impl From<Result<(), QueryInterruptLineError>> for ResultCode

fn from(x: Result<(), QueryInterruptLineError>) -> Self

Performs the conversion.

impl From<Result<(), QueryMutexError>> for ResultCode

fn from(x: Result<(), QueryMutexError>) -> Self

Performs the conversion.

impl From<Result<(), SetInterruptLinePriorityError>> for ResultCode

fn from(x: Result<(), SetInterruptLinePriorityError>) -> Self

Performs the conversion.

impl From<Result<(), SetTaskPriorityError>> for ResultCode

fn from(x: Result<(), SetTaskPriorityError>) -> Self

Performs the conversion.

impl From<Result<(), SetTimerDelayError>> for ResultCode

fn from(x: Result<(), SetTimerDelayError>) -> Self

Performs the conversion.

impl From<Result<(), SetTimerPeriodError>> for ResultCode

fn from(x: Result<(), SetTimerPeriodError>) -> Self

Performs the conversion.

impl From<Result<(), SignalSemaphoreError>> for ResultCode

fn from(x: Result<(), SignalSemaphoreError>) -> Self

Performs the conversion.

impl From<Result<(), SleepError>> for ResultCode

fn from(x: Result<(), SleepError>) -> Self

Performs the conversion.

impl From<Result<(), StartTimerError>> for ResultCode

fn from(x: Result<(), StartTimerError>) -> Self

Performs the conversion.

impl From<Result<(), StopTimerError>> for ResultCode

fn from(x: Result<(), StopTimerError>) -> Self

Performs the conversion.

impl From<Result<(), TimeError>> for ResultCode

fn from(x: Result<(), TimeError>) -> Self

Performs the conversion.

impl From<Result<(), TryLockMutexError>> for ResultCode

fn from(x: Result<(), TryLockMutexError>) -> Self

Performs the conversion.

impl From<Result<(), UnlockMutexError>> for ResultCode

fn from(x: Result<(), UnlockMutexError>) -> Self

Performs the conversion.

impl From<Result<(), UnparkError>> for ResultCode

fn from(x: Result<(), UnparkError>) -> Self

Performs the conversion.

impl From<Result<(), UnparkExactError>> for ResultCode

fn from(x: Result<(), UnparkExactError>) -> Self

Performs the conversion.

impl From<Result<(), UpdateEventGroupError>> for ResultCode

fn from(x: Result<(), UpdateEventGroupError>) -> Self

Performs the conversion.

impl From<Result<(), WaitError>> for ResultCode

fn from(x: Result<(), WaitError>) -> Self

Performs the conversion.

impl From<Result<(), WaitEventGroupError>> for ResultCode

fn from(x: Result<(), WaitEventGroupError>) -> Self

Performs the conversion.

impl From<Result<(), WaitEventGroupTimeoutError>> for ResultCode

fn from(x: Result<(), WaitEventGroupTimeoutError>) -> Self

Performs the conversion.

impl From<Result<(), WaitSemaphoreError>> for ResultCode

fn from(x: Result<(), WaitSemaphoreError>) -> Self

Performs the conversion.

impl From<Result<(), WaitSemaphoreTimeoutError>> for ResultCode

fn from(x: Result<(), WaitSemaphoreTimeoutError>) -> Self

Performs the conversion.

impl From<Result<(), WaitTimeoutError>> for ResultCode

fn from(x: Result<(), WaitTimeoutError>) -> Self

Performs the conversion.

impl From<SetInterruptLinePriorityError> for ResultCode

fn from(x: SetInterruptLinePriorityError) -> Self

Performs the conversion.

impl From<SetTaskPriorityError> for ResultCode

fn from(x: SetTaskPriorityError) -> Self

Performs the conversion.

impl From<SetTimerDelayError> for ResultCode

fn from(x: SetTimerDelayError) -> Self

Performs the conversion.

impl From<SetTimerPeriodError> for ResultCode

fn from(x: SetTimerPeriodError) -> Self

Performs the conversion.

impl From<SignalSemaphoreError> for ResultCode

fn from(x: SignalSemaphoreError) -> Self

Performs the conversion.

impl From<SleepError> for ResultCode

fn from(x: SleepError) -> Self

Performs the conversion.

impl From<StartTimerError> for ResultCode

fn from(x: StartTimerError) -> Self

Performs the conversion.

impl From<StopTimerError> for ResultCode

fn from(x: StopTimerError) -> Self

Performs the conversion.

impl From<TimeError> for ResultCode

fn from(x: TimeError) -> Self

Performs the conversion.

impl From<TryLockMutexError> for ResultCode

fn from(x: TryLockMutexError) -> Self

Performs the conversion.

impl From<UnlockMutexError> for ResultCode

fn from(x: UnlockMutexError) -> Self

Performs the conversion.

impl From<UnparkError> for ResultCode

fn from(x: UnparkError) -> Self

Performs the conversion.

impl From<UnparkExactError> for ResultCode

fn from(x: UnparkExactError) -> Self

Performs the conversion.

impl From<UpdateEventGroupError> for ResultCode

fn from(x: UpdateEventGroupError) -> Self

Performs the conversion.

impl From<WaitError> for ResultCode

fn from(x: WaitError) -> Self

Performs the conversion.

impl From<WaitEventGroupError> for ResultCode

fn from(x: WaitEventGroupError) -> Self

Performs the conversion.

impl From<WaitEventGroupTimeoutError> for ResultCode

fn from(x: WaitEventGroupTimeoutError) -> Self

Performs the conversion.

impl From<WaitSemaphoreError> for ResultCode

fn from(x: WaitSemaphoreError) -> Self

Performs the conversion.

impl From<WaitSemaphoreTimeoutError> for ResultCode

fn from(x: WaitSemaphoreTimeoutError) -> Self

Performs the conversion.

impl From<WaitTimeoutError> for ResultCode

fn from(x: WaitTimeoutError) -> Self

Performs the conversion.

impl Hash for ResultCode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ResultCode

fn cmp(&self, other: &ResultCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ResultCode> for ResultCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ResultCode> for ResultCode

fn partial_cmp(&self, other: &ResultCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ResultCode

impl Eq for ResultCode

impl StructuralEq for ResultCode

impl StructuralPartialEq for ResultCode