Struct freya::prelude::Task

pub struct Task(/* private fields */);

A task’s unique identifier.

Task is a unique identifier for a task that has been spawned onto the runtime. It can be used to cancel the task

Implementations

impl Task

pub fn new(task: impl Future<Output = ()> + 'static) -> Task

Start a new future on the same thread as the rest of the VirtualDom.

This future will not contribute to suspense resolving, so you should primarily use this for reacting to changes and long running tasks.

Whenever the component that owns this future is dropped, the future will be dropped as well.

Spawning a future onto the root scope will cause it to be dropped when the root component is dropped - which will only occur when the VirtualDom itself has been dropped.

pub fn cancel(self)

Drop the task immediately.

This does not abort the task, so you’ll want to wrap it in an abort handle if that’s important to you

pub fn pause(&self)

Pause the task.

pub fn resume(&self)

Resume the task.

pub fn paused(&self) -> bool

Check if the task is paused.

pub fn wake(&self)

Wake the task.

pub fn poll_now(&self) -> Poll<()>

Poll the task immediately.

pub fn set_active(&self, active: bool)

Set the task as active or paused.

Trait Implementations

impl Clone for Task

fn clone(&self) -> Task

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Task

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Task

fn deserialize<__D>( __deserializer: __D, ) -> Result<Task, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Task

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 PartialEq for Task

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Task

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Task

impl Eq for Task

impl StructuralPartialEq for Task