Struct r3::kernel::LocalTask

pub struct LocalTask<System>(_, _)
where
    System: KernelBase;

A non-Send, 'static task reference. The lack of Send-ness constrains its lifetime to the owning task and thus allows it to represent a current task safely.

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

Implementations

impl<System> LocalTask<System>where
    System: KernelBase,

pub fn current() -> Result<LocalTask<System>, GetCurrentTaskError>

Get the current task (i.e., the task that is assigned to the current processor and in the Running state).

Returns GetCurrentTaskError::BadContext if called from a non-task context.

Rationale: Getting a current task in a non-task context does make sense, but the result may be soon invalidated (potentially violating the [object safety] of LocalTask) and made unreliable by various factors.

Trait Implementations

impl<System> Clone for LocalTask<System>where
    System: KernelBase,

fn clone(&self) -> LocalTask<System>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<System> Debug for LocalTask<System>where
    System: KernelBase,

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

Formats the value using the given formatter.

impl<System> Hash for LocalTask<System>where
    System: KernelBase,

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<System, T> PartialEq<T> for LocalTask<System>where
    System: KernelBase,
    T: TaskHandle<System = System>,

fn eq(&self, other: &T) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<System> TaskHandle for LocalTask<System>where
    System: KernelBase,

type System = System

The system type this object pertains to.

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

Construct a Task from RawTaskId.

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

Get the raw RawTaskId value representing this object.

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

Borrow self as TaskRef.

impl<System> Copy for LocalTask<System>where
    System: KernelBase,

impl<System> Eq for LocalTask<System>where
    System: KernelBase,

impl<System> Sync for LocalTask<System>where
    System: KernelBase,