Struct itron_solid_fmp3::task::Task

pub struct Task(_);

This is supported on crate features unstable and dcre only.

An owned task.

Deletes the task automatically when dropped. The destructor will panic if the deletion fails.

Implementations

impl Task

pub fn build(
) -> Builder<__start_is_not_specified__, __stack_is_not_specified__, __initial_priority_is_not_specified__>

acre_tsk: Create a builder for Task.

Example

use itron::task::Task;
let captured_variable = 42u16;
let task = Task::build()
    .start(move || { let _ = captured_variable; })
    .stack_size(4096)
    .initial_priority(4)
    .finish_and_activate()
    .expect("failed to create a task");

task.as_ref().wake().expect("failed to send a wake up request to the created task");

// The created task might be still active, so if we just let `task`
// go out of scope, its destructor will panic. `Task::leak` consumes
// `Task` and prevents the destructor from running.
task.leak();

impl Task

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a Task from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn leak<'a>(self) -> TaskRef<'a>

Consume and “leak” self, returning a reference TaskRef<'a>.

pub const fn as_raw(&self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(&self) -> NonNullID

Get the raw object ID as abi::NonNullID.

pub const fn as_ref(&self) -> TaskRef<'_>

Borrow Task as TaskRef.

Use this to perform operations on tasks because most of the methods are implemented on TaskRef but not Task.

Trait Implementations

impl Debug for Task

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

Formats the value using the given formatter.

impl Drop for Task

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Task> for Task

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

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

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

This method tests for !=.

impl Eq for Task

impl StructuralEq for Task

impl StructuralPartialEq for Task