Struct r3_core::kernel::task::Task

#[repr(transparent)]
pub struct Task<System: NotSupportedYet>(_);

Expand description

Represents a single task in a system.

This type is ABI-compatible with System::RawTaskId.

See TaskRef for the borrowed counterpart. See TaskMethods for the operations provided by this handle type.

Relation to Other Specifications: Present in almost every real-time operating system.

Task States

A task may be in one of the following states:

Dormant — The task is not executing, doesn’t have an associated execution thread, and can be activated.
Ready — The task has an associated execution thread, which is ready to be scheduled to the CPU
Running — The task has an associated execution thread, which is currently scheduled to the CPU
Waiting — The task has an associated execution thread, which is currently blocked by a blocking operation

Trait Implementations

impl<System: NotSupportedYet> Debug for Task<System>

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

Formats the value using the given formatter. Read more

impl<System: NotSupportedYet> Hash for Task<System>

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl<System: NotSupportedYet> PartialEq<Task<System>> for Task<System>

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

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl<System: NotSupportedYet> PartialEq<Task<System>> for TaskRef<'_, System>

fn eq(&self, other: &Task<System>) -> bool

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl<System: NotSupportedYet> PartialEq<TaskRef<'_, System>> for Task<System>

fn eq(&self, other: &TaskRef<'_, System>) -> bool

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

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl<System: NotSupportedYet> TaskHandle for Task<System>

type System = System

The system type this object pertains to.

const unsafe fn from_id(id: <System as KernelBase>::RawTaskId) -> Self

Construct a Task from RawTaskId. Read more

const fn id(&self) -> System::RawTaskId

Get the raw RawTaskId value representing this object.

const fn borrow(&self) -> TaskRef<'_, Self::System>

Borrow self as TaskRef. Read more

impl<System: NotSupportedYet> Eq for Task<System>

Auto Trait Implementations

impl<System> RefUnwindSafe for Task<System>where
<System as KernelBase>::RawTaskId: RefUnwindSafe,

impl<System> Send for Task<System>

impl<System> Sync for Task<System>

impl<System> Unpin for Task<System>where
<System as KernelBase>::RawTaskId: Unpin,

impl<System> UnwindSafe for Task<System>where
<System as KernelBase>::RawTaskId: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · 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.

impl<T> TaskMethods for Twhere
T: TaskHandle,

fn activate(&self) -> Result<(), ActivateTaskError>

Start the execution of the task.

fn interrupt(&self) -> Result<(), InterruptTaskError>

Interrupt any ongoing wait operations undertaken by the task. Read more

fn unpark(&self) -> Result<(), UnparkError>

Make the task’s token available, unblocking Kernel::park now or in the future. Read more

fn unpark_exact(&self) -> Result<(), UnparkExactError>

Make exactly one new token available for the task, unblocking Kernel::park now or in the future. Read more

fn set_priority(&self, priority: usize) -> Result<(), SetTaskPriorityError>where
Self::System: KernelTaskSetPriority,

Set the task’s base priority. Read more

fn priority(&self) -> Result<usize, GetTaskPriorityError>

Get the task’s base priority. Read more

fn effective_priority(&self) -> Result<usize, GetTaskPriorityError>

Get the task’s effective priority. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.