TaskQueue

Struct TaskQueue 

Source
pub struct TaskQueue<B: QueueBacking> { /* private fields */ }
Expand description

Sends ordered tasks to a pool for background processing.

Implementations§

Source§

impl<B: PushPopQueueBacking> TaskQueue<B>

Source

pub fn join<T>(&self, task: impl TaskCollection<T>) -> T

Joins the pool in executing the given task. Both the current thread and the background threads complete the task’s work. Semantically, this is equivalent to calling spawn(task).join(), but is more efficient by ensuring that the present thread always receives at least one work item.

Source

pub fn spawn<T>(&self, task: impl TaskCollection<T>) -> Task<T, B>

Spawns a new task into the queue.

Source§

impl<P: Ord + Send + Sync> TaskQueue<Priority<P>>

Source

pub fn join<T>(&self, priority: P, task: impl TaskCollection<T>) -> T

Joins the pool in executing the given task. Both the current thread and the background threads complete the task’s work. Semantically, this is equivalent to calling spawn(task).join(), but is more efficient by ensuring that the present thread always receives at least one work item.

Source

pub fn spawn<T>( &self, priority: P, task: impl TaskCollection<T>, ) -> Task<T, Priority<P>>

Spawns a new task into the queue, with the given priority.

Trait Implementations§

Source§

impl<B: QueueBacking> Clone for TaskQueue<B>

Source§

fn clone(&self) -> Self

Returns a duplicate 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<B: Debug + QueueBacking> Debug for TaskQueue<B>

Source§

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

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

impl<B: QueueBacking> Default for TaskQueue<B>

Source§

fn default() -> Self

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

impl<B: QueueBacking> WorkProvider for TaskQueue<B>

Source§

fn change_notifier(&self) -> &ChangeNotifier

Gets a reference to the notifier which raises an event when new work is available.
Source§

fn next_task(&self) -> Option<Box<dyn WorkUnit>>

Obtains the next unit of queued work from the provider.

Auto Trait Implementations§

§

impl<B> Freeze for TaskQueue<B>

§

impl<B> RefUnwindSafe for TaskQueue<B>

§

impl<B> Send for TaskQueue<B>

§

impl<B> Sync for TaskQueue<B>

§

impl<B> Unpin for TaskQueue<B>

§

impl<B> UnwindSafe for TaskQueue<B>

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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,

Source§

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

Source§

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

Source§

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.