Struct r3::kernel::cfg::CfgTaskBuilder

pub struct CfgTaskBuilder<System> { /* fields omitted */ }

Configuration builder type for Task.

Implementations

impl<System: Port> CfgTaskBuilder<System>

pub const fn start(self, start: fn(_: usize)) -> Self

[Required] Specify the task’s entry point.

pub const fn param(self, param: usize) -> Self

Specify the parameter to start. Defaults to 0.

pub const fn stack_size(self, stack_size: usize) -> Self

Specify the task’s stack size.

pub const fn stack_hunk(self, stack_hunk: StackHunk<System>) -> Self

Specify the task’s hunk.

pub const fn priority(self, priority: usize) -> Self

[Required] Specify the task’s initial base priority. Tasks with lower priority values execute first. The value must be in range 0..num_task_priority_levels.

pub const fn active(self, active: bool) -> Self

Specify whether the task should be activated at system startup. Defaults to false (don’t activate).

pub const fn finish(self, cfg: &mut CfgBuilder<System>) -> Task<System>

Complete the definition of a task, returning a reference to the task.