#[non_exhaustive]
pub struct ScheduleInfo { pub woken_while_running: bool, }
Expand description

Extra scheduling information that can be passed to the scheduling function.

The data source of this struct is directly from the actual implementation of the crate itself, different from Runnable’s metadata, which is managed by the caller.

Examples

use async_task::{Runnable, ScheduleInfo, WithInfo};
use std::sync::{Arc, Mutex};

// The future inside the task.
let future = async {
    println!("Hello, world!");
};

// If the task gets woken up while running, it will be sent into this channel.
let (s, r) = flume::unbounded();
// Otherwise, it will be placed into this slot.
let lifo_slot = Arc::new(Mutex::new(None));
let schedule = move |runnable: Runnable, info: ScheduleInfo| {
    if info.woken_while_running {
        s.send(runnable).unwrap()
    } else {
        let last = lifo_slot.lock().unwrap().replace(runnable);
        if let Some(last) = last {
            s.send(last).unwrap()
        }
    }
};

// Create the actual scheduler to be spawned with some future.
let scheduler = WithInfo(schedule);
// Create a task with the future and the scheduler.
let (runnable, task) = async_task::spawn(future, scheduler);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§woken_while_running: bool

Indicates whether the task gets woken up while running.

It is set to true usually because the task has yielded itself to the scheduler.

Trait Implementations§

source§

impl Clone for ScheduleInfo

source§

fn clone(&self) -> ScheduleInfo

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 Debug for ScheduleInfo

source§

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

Formats the value using the given formatter. Read more
source§

impl Copy for ScheduleInfo

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.