Struct itron_solid_fmp3::task::Builder

pub struct Builder<Start, Stack, InitialPriority> { /* fields omitted */ }

This is supported on crate features unstable and dcre only.

The builder type for tasks. Created by Task::build.

Its generic parameters are an implementation detail.

Implementations

impl<Start, Stack, InitialPriority> Builder<Start, Stack, InitialPriority>

pub fn start(
    self,
    value: impl IntoClosure + Send
) -> Builder<(), Stack, InitialPriority>

(Mandatory) Specify the entry point.

pub fn stack_size(self, size: usize) -> Builder<Start, (), InitialPriority>

(Mandatory) Specify to use an automatically allocated stack region of the specified size.

pub fn initial_priority(self, value: Priority) -> Builder<Start, Stack, ()>

(Mandatory) Specify the initial priority.

pub fn initial_processor(self, value: Processor) -> Self

Specify the task’s initial assigned processor. Defaults to the current processor when unspecified.

pub fn processor_affinity(self, value: impl IntoProcessorSet) -> Self

Specify the task’s assignable processsor set. Defaults to all processors when unspecified.

This function might panic if an invalid processor ID is specified or the set is empty.

Examples

#![feature(const_option)]
use itron::{task::Task, processor::Processor};
let processor = itron::processor::current().unwrap();
let task = Task::build()
    .start(move || {})
    .stack_size(4096)
    .initial_priority(4)
    .initial_processor(processor)
    .processor_affinity([processor])
    .finish()
    .expect("failed to create a task");

impl Builder<(), (), ()>

pub fn finish(self) -> Result<Task, Error<BuildError>>

Create a task using the specified parameters.

pub fn finish_and_activate(self) -> Result<Task, Error<BuildError>>

Create and activate a task using the specified parameters.