pub struct ThreadExecutor<'task> { /* private fields */ }
Expand description

An executor that can only be ticked on the thread it was instantiated on. But can spawn Send tasks from other threads.

Example

use bevy_tasks::ThreadExecutor;

let thread_executor = ThreadExecutor::new();
let count = Arc::new(AtomicI32::new(0));

// create some owned values that can be moved into another thread
let count_clone = count.clone();

std::thread::scope(|scope| {
    scope.spawn(|| {
        // we cannot get the ticker from another thread
        let not_thread_ticker = thread_executor.ticker();
        assert!(not_thread_ticker.is_none());
         
        // but we can spawn tasks from another thread
        thread_executor.spawn(async move {
            count_clone.fetch_add(1, Ordering::Relaxed);
        }).detach();
    });
});

// the tasks do not make progress unless the executor is manually ticked
assert_eq!(count.load(Ordering::Relaxed), 0);

// tick the ticker until task finishes
let thread_ticker = thread_executor.ticker().unwrap();
thread_ticker.try_tick();
assert_eq!(count.load(Ordering::Relaxed), 1);

Implementations§

source§

impl<'task> ThreadExecutor<'task>

source

pub fn new() -> Self

create a new ThreadExecutor

source

pub fn spawn<T: Send + 'task>( &self, future: impl Future<Output = T> + Send + 'task ) -> Task<T>

Spawn a task on the thread executor

source

pub fn ticker<'ticker>( &'ticker self ) -> Option<ThreadExecutorTicker<'task, 'ticker>>

Gets the ThreadExecutorTicker for this executor. Use this to tick the executor. It only returns the ticker if it’s on the thread the executor was created on and returns None otherwise.

source

pub fn is_same(&self, other: &Self) -> bool

Returns true if self and other’s executor is same

Trait Implementations§

source§

impl<'task> Debug for ThreadExecutor<'task>

source§

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

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

impl<'task> Default for ThreadExecutor<'task>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'task> RefUnwindSafe for ThreadExecutor<'task>

§

impl<'task> Send for ThreadExecutor<'task>

§

impl<'task> Sync for ThreadExecutor<'task>

§

impl<'task> Unpin for ThreadExecutor<'task>

§

impl<'task> UnwindSafe for ThreadExecutor<'task>

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, 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.