Skip to main content

Event

Enum Event 

Source
#[non_exhaustive]
pub enum Event<'a> {
Show 46 variants StartingScheduler, TaskCreate { task: Handle<Task>, name: &'a str, priority: Priority, }, TaskCreateFailed, TaskDelete { task: Handle<Task>, name: &'a str, }, TaskSwitchedIn { task: Handle<Task>, name: &'a str, }, TaskSwitchedOut { task: Handle<Task>, name: &'a str, }, TaskDelay { task: Handle<Task>, name: &'a str, ticks: u64, }, TaskDelayUntil { task: Handle<Task>, name: &'a str, wake_at: u64, }, TaskSuspend { task: Handle<Task>, name: &'a str, }, TaskResume { task: Handle<Task>, name: &'a str, }, TaskResumeFromIsr { task: Handle<Task>, name: &'a str, }, TaskPrioritySet { task: Handle<Task>, name: &'a str, priority: Priority, }, TaskPriorityInherit { task: Handle<Task>, name: &'a str, priority: Priority, }, TaskPriorityDisinherit { task: Handle<Task>, name: &'a str, priority: Priority, }, TaskIncrementTick { tick: u64, }, MovedTaskToReadyState { task: Handle<Task>, name: &'a str, }, MovedTaskToDelayedList { task: Handle<Task>, name: &'a str, }, MovedTaskToOverflowDelayedList { task: Handle<Task>, name: &'a str, }, TaskNotify { task: Handle<Task>, name: &'a str, index: usize, }, TaskNotifyWait { task: Handle<Task>, name: &'a str, index: usize, }, TaskNotifyWaitBlock { task: Handle<Task>, name: &'a str, index: usize, }, TaskNotifyTake { task: Handle<Task>, name: &'a str, index: usize, }, TaskNotifyTakeBlock { task: Handle<Task>, name: &'a str, index: usize, }, QueueCreate { queue: Handle<Queue>, name: &'a str, length: usize, }, QueueSend { queue: Handle<Queue>, name: &'a str, }, QueueSendFailed { queue: Handle<Queue>, name: &'a str, }, QueueSendFromIsr { queue: Handle<Queue>, name: &'a str, }, QueueReceive { queue: Handle<Queue>, name: &'a str, }, QueueReceiveFailed { queue: Handle<Queue>, name: &'a str, }, QueueReceiveFromIsr { queue: Handle<Queue>, name: &'a str, }, QueuePeek { queue: Handle<Queue>, name: &'a str, }, BlockingOnQueueSend { queue: Handle<Queue>, name: &'a str, }, BlockingOnQueueReceive { queue: Handle<Queue>, name: &'a str, }, BlockingOnQueuePeek { queue: Handle<Queue>, name: &'a str, }, TimerCreate { timer: Handle<Timer>, name: &'a str, }, TimerCommandSend { timer: Handle<Timer>, name: &'a str, command: i32, value: u64, }, TimerExpired { timer: Handle<Timer>, name: &'a str, }, EventGroupCreate { group: Handle<EventGroup>, }, EventGroupSetBits { group: Handle<EventGroup>, bits: u32, }, EventGroupWaitBitsBlock { group: Handle<EventGroup>, bits: u32, }, EventGroupWaitBitsEnd { group: Handle<EventGroup>, bits: u32, timed_out: bool, }, StreamBufferCreate { buffer: Handle<StreamBuffer>, is_message_buffer: bool, }, StreamBufferSend { buffer: Handle<StreamBuffer>, bytes: usize, }, StreamBufferReceive { buffer: Handle<StreamBuffer>, bytes: usize, }, LowPowerIdleBegin, LowPowerIdleEnd,
}
Expand description

One kernel event, with what the corresponding C macro receives.

Field names are the C macro’s own parameter names in snake case (task / name for a TCB, queue, timer, group, buffer), which is why they carry no doc of their own.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

StartingScheduler

traceSTARTING_SCHEDULER.

§

TaskCreate

traceTASK_CREATE.

Fields

§task: Handle<Task>
§name: &'a str
§priority: Priority
§

TaskCreateFailed

traceTASK_CREATE_FAILED.

§

TaskDelete

traceTASK_DELETE.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskSwitchedIn

traceTASK_SWITCHED_IN.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskSwitchedOut

traceTASK_SWITCHED_OUT.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskDelay

traceTASK_DELAY.

Fields

§task: Handle<Task>
§name: &'a str
§ticks: u64
§

TaskDelayUntil

traceTASK_DELAY_UNTIL.

Fields

§task: Handle<Task>
§name: &'a str
§wake_at: u64
§

TaskSuspend

traceTASK_SUSPEND.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskResume

traceTASK_RESUME.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskResumeFromIsr

traceTASK_RESUME_FROM_ISR.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskPrioritySet

traceTASK_PRIORITY_SET.

Fields

§task: Handle<Task>
§name: &'a str
§priority: Priority
§

TaskPriorityInherit

traceTASK_PRIORITY_INHERIT.

Fields

§task: Handle<Task>
§name: &'a str
§priority: Priority
§

TaskPriorityDisinherit

traceTASK_PRIORITY_DISINHERIT.

Fields

§task: Handle<Task>
§name: &'a str
§priority: Priority
§

TaskIncrementTick

traceTASK_INCREMENT_TICK.

Fields

§tick: u64
§

MovedTaskToReadyState

traceMOVED_TASK_TO_READY_STATE.

Fields

§task: Handle<Task>
§name: &'a str
§

MovedTaskToDelayedList

traceMOVED_TASK_TO_DELAYED_LIST.

Fields

§task: Handle<Task>
§name: &'a str
§

MovedTaskToOverflowDelayedList

traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST.

Fields

§task: Handle<Task>
§name: &'a str
§

TaskNotify

traceTASK_NOTIFY.

Fields

§task: Handle<Task>
§name: &'a str
§index: usize
§

TaskNotifyWait

traceTASK_NOTIFY_WAIT.

Fields

§task: Handle<Task>
§name: &'a str
§index: usize
§

TaskNotifyWaitBlock

traceTASK_NOTIFY_WAIT_BLOCK.

Fields

§task: Handle<Task>
§name: &'a str
§index: usize
§

TaskNotifyTake

traceTASK_NOTIFY_TAKE.

Fields

§task: Handle<Task>
§name: &'a str
§index: usize
§

TaskNotifyTakeBlock

traceTASK_NOTIFY_TAKE_BLOCK.

Fields

§task: Handle<Task>
§name: &'a str
§index: usize
§

QueueCreate

traceQUEUE_CREATE.

Fields

§queue: Handle<Queue>
§name: &'a str
§length: usize
§

QueueSend

traceQUEUE_SEND.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueueSendFailed

traceQUEUE_SEND_FAILED.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueueSendFromIsr

traceQUEUE_SEND_FROM_ISR.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueueReceive

traceQUEUE_RECEIVE.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueueReceiveFailed

traceQUEUE_RECEIVE_FAILED.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueueReceiveFromIsr

traceQUEUE_RECEIVE_FROM_ISR.

Fields

§queue: Handle<Queue>
§name: &'a str
§

QueuePeek

traceQUEUE_PEEK.

Fields

§queue: Handle<Queue>
§name: &'a str
§

BlockingOnQueueSend

traceBLOCKING_ON_QUEUE_SEND.

Fields

§queue: Handle<Queue>
§name: &'a str
§

BlockingOnQueueReceive

traceBLOCKING_ON_QUEUE_RECEIVE.

Fields

§queue: Handle<Queue>
§name: &'a str
§

BlockingOnQueuePeek

traceBLOCKING_ON_QUEUE_PEEK.

Fields

§queue: Handle<Queue>
§name: &'a str
§

TimerCreate

traceTIMER_CREATE.

Fields

§timer: Handle<Timer>
§name: &'a str
§

TimerCommandSend

traceTIMER_COMMAND_SEND.

Fields

§timer: Handle<Timer>
§name: &'a str
§command: i32
§value: u64
§

TimerExpired

traceTIMER_EXPIRED.

Fields

§timer: Handle<Timer>
§name: &'a str
§

EventGroupCreate

traceEVENT_GROUP_CREATE.

Fields

§

EventGroupSetBits

traceEVENT_GROUP_SET_BITS.

Fields

§bits: u32
§

EventGroupWaitBitsBlock

traceEVENT_GROUP_WAIT_BITS_BLOCK.

Fields

§bits: u32
§

EventGroupWaitBitsEnd

traceEVENT_GROUP_WAIT_BITS_END.

Fields

§bits: u32
§timed_out: bool
§

StreamBufferCreate

traceSTREAM_BUFFER_CREATE.

Fields

§is_message_buffer: bool
§

StreamBufferSend

traceSTREAM_BUFFER_SEND.

Fields

§bytes: usize
§

StreamBufferReceive

traceSTREAM_BUFFER_RECEIVE.

Fields

§bytes: usize
§

LowPowerIdleBegin

traceLOW_POWER_IDLE_BEGIN.

§

LowPowerIdleEnd

traceLOW_POWER_IDLE_END.

Implementations§

Source§

impl Event<'_>

Source

pub const fn name(&self) -> &'static str

The C macro’s suffix: the second field of a trace line.

Source

pub const fn subject(&self) -> Option<&str>

The name the C side prints in the third field, when the event has one.

Trait Implementations§

Source§

impl<'a> Clone for Event<'a>

Source§

fn clone(&self) -> Event<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Event<'a>

Source§

impl<'a> Debug for Event<'a>

Source§

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

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

impl<'a> Eq for Event<'a>

Source§

impl<'a> PartialEq for Event<'a>

Source§

fn eq(&self, other: &Event<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for Event<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Event<'a>

§

impl<'a> RefUnwindSafe for Event<'a>

§

impl<'a> Send for Event<'a>

§

impl<'a> Sync for Event<'a>

§

impl<'a> Unpin for Event<'a>

§

impl<'a> UnsafeUnpin for Event<'a>

§

impl<'a> UnwindSafe for Event<'a>

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.