Struct r3::kernel::task::TaskRef

source ·

pub struct TaskRef<'a, System>(_, _)
where
    System: KernelBase;

Expand description

Represents a single borrowed task in a system.

This type is ABI-compatible with System::RawTaskId. It’s logically equivalent to &'a Task but instead stores RawTaskId directly.

See Task for the owned counterpart and the description of this kernel object. See TaskMethods for the operations provided by this handle type.

Implementations

source

impl<System> TaskRef<'static, System>where
System: KernelBase,

source

pub const fn define() -> TaskDefiner<System>

Construct a TaskDefiner to define a task in a configuration function.

Trait Implementations

source

impl<System> Clone for TaskRef<'_, System>where
System: KernelBase,

source

fn clone(&self) -> TaskRef<'_, System>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<System> Debug for TaskRef<'_, System>where
System: KernelBase,

source

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

Formats the value using the given formatter. Read more

source

impl<System> Hash for TaskRef<'_, System>where
System: KernelBase,

source

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

source

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

source

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

source

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

source

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

source

impl<System> PartialEq<TaskRef<'_, System>> for TaskRef<'_, System>where
System: KernelBase,

source

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

source

impl<System> TaskHandle for TaskRef<'_, System>where
System: KernelBase,

type System = System

The system type this object pertains to.

source

const unsafe fn from_id(
id: <System as KernelBase>::RawTaskId
) -> TaskRef<'_, System>

Construct a Task from RawTaskId. Read more

source

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

Get the raw RawTaskId value representing this object.

source

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

Borrow self as TaskRef. Read more

source

impl<System> Copy for TaskRef<'_, System>where
System: KernelBase,

source

impl<System> Eq for TaskRef<'_, System>where
System: KernelBase,

Auto Trait Implementations

impl<'a, System> RefUnwindSafe for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: RefUnwindSafe,

impl<'a, System> Send for TaskRef<'a, System>

impl<'a, System> Sync for TaskRef<'a, System>

impl<'a, System> Unpin for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: Unpin,

impl<'a, System> UnwindSafe for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: UnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into 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.

source

impl<T> TaskMethods for Twhere
T: TaskHandle,

source

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

Start the execution of the task.

source

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

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

source

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

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

source

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

source

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

Set the task’s base priority. Read more

source

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

Get the task’s base priority. Read more

source

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

Get the task’s effective priority. Read more

source

impl<T, U> TryFrom 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct r3::kernel::task::TaskRef

Implementations

impl<System> TaskRef<'static, System>where System: KernelBase,

pub const fn define() -> TaskDefiner<System>

Trait Implementations

impl<System> Clone for TaskRef<'_, System>where System: KernelBase,

fn clone(&self) -> TaskRef<'_, System>

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

impl<System> Debug for TaskRef<'_, System>where System: KernelBase,

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

impl<System> Hash for TaskRef<'_, System>where System: KernelBase,

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

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

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

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

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

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

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

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

impl<System> PartialEq<TaskRef<'_, System>> for TaskRef<'_, System>where System: KernelBase,

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

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

impl<System> TaskHandle for TaskRef<'_, System>where System: KernelBase,

type System = System

const unsafe fn from_id( id: <System as KernelBase>::RawTaskId) -> TaskRef<'_, System>

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

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

impl<System> Copy for TaskRef<'_, System>where System: KernelBase,

impl<System> Eq for TaskRef<'_, System>where System: KernelBase,

Auto Trait Implementations

impl<'a, System> RefUnwindSafe for TaskRef<'a, System>where <System as KernelBase>::RawTaskId: RefUnwindSafe,

impl<'a, System> Send for TaskRef<'a, System>

impl<'a, System> Sync for TaskRef<'a, System>

impl<'a, System> Unpin for TaskRef<'a, System>where <System as KernelBase>::RawTaskId: Unpin,

impl<'a, System> UnwindSafe for TaskRef<'a, System>where <System as KernelBase>::RawTaskId: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> TaskMethods for Twhere T: TaskHandle,

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

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

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

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

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

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

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

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

type Error = Infallible

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

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

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

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

impl<System> TaskRef<'static, System>where
System: KernelBase,

impl<System> Clone for TaskRef<'_, System>where
System: KernelBase,

impl<System> Debug for TaskRef<'_, System>where
System: KernelBase,

impl<System> Hash for TaskRef<'_, System>where
System: KernelBase,

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

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

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

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

impl<System> PartialEq<TaskRef<'_, System>> for TaskRef<'_, System>where
System: KernelBase,

impl<System> TaskHandle for TaskRef<'_, System>where
System: KernelBase,

const unsafe fn from_id(
id: <System as KernelBase>::RawTaskId
) -> TaskRef<'_, System>

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

impl<System> Copy for TaskRef<'_, System>where
System: KernelBase,

impl<System> Eq for TaskRef<'_, System>where
System: KernelBase,

impl<'a, System> RefUnwindSafe for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: RefUnwindSafe,

impl<'a, System> Unpin for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: Unpin,

impl<'a, System> UnwindSafe for TaskRef<'a, System>where
<System as KernelBase>::RawTaskId: UnwindSafe,

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

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

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

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

impl<T> TaskMethods for Twhere
T: TaskHandle,

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

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

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