Enum xous_api_ticktimer::api::Opcode

#[repr(usize)]
pub enum Opcode {
    ElapsedMs,
    SleepMs,
    RecalculateSleep,
    SuspendResume,
    PingWdt,
    GetVersion,
    LockMutex,
    UnlockMutex,
    WaitForCondition,
    NotifyCondition,
    FreeMutex,
    FreeCondition,
    InvalidCall,
}

Do not modify the discriminants in this structure. They are used in libstd directly.

Variants

ElapsedMs

Get the elapsed time in milliseconds

SleepMs

Sleep for the specified numer of milliseconds

RecalculateSleep

Recalculate the sleep time

SuspendResume

Suspend/resume callback

PingWdt

force a WDT update

GetVersion

Return the version string of Xous. We bury it here because this is a small, lightweight server we can rebuild on every run.

LockMutex

Lock the given Mutex, blocking if it is already locked.

Arguments

arg1: An integer of some sort, such as the address of the Mutex

UnlockMutex

Unlock the given Mutex

Arguments

arg1: An integer of some sort, such as the address of the Mutex

WaitForCondition

Wait for a given condition to be signalled

Arguments

arg1: An integer of some sort, such as the address of the Condvar arg2: The number of milliseconds to wait, or 0 to wait forever

NotifyCondition

Notify a condition

Arguments

arg1: An integer of some sort, such as the address of the Condvar arg2: The number of conditions to notify

FreeMutex

Free a Mutex

This call will free a Mutex that was previously Locked or Unlocked. Doing so causes the Mutex to be unlocked.

Arguments

arg1: The integer that matches the Mutex value

FreeCondition

Free a Condition

This call will free a Condition that was previously waited upon. All pending threads will be forgotten.

Arguments

arg1: The integer that matches the Condition value

InvalidCall

Invalid call – an error occurred decoding the opcode

Trait Implementations

impl Debug for Opcode

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

Formats the value using the given formatter.

impl FromPrimitive for Opcode

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl ToPrimitive for Opcode

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.