Skip to main content

ThreadPerTaskExecutorService

Struct ThreadPerTaskExecutorService 

Source
pub struct ThreadPerTaskExecutorService { /* private fields */ }
Expand description

Managed service that runs every accepted task on a dedicated OS thread.

The service has no queue: accepted tasks start immediately on their own thread. Shutdown prevents later submissions but cannot forcefully stop running OS threads.

Implementations§

Source§

impl ThreadPerTaskExecutorService

Source

pub fn new() -> Self

Creates a new service instance.

§Returns

A service that accepts tasks until shutdown is requested.

Source

pub fn builder() -> ThreadPerTaskExecutorServiceBuilder

Creates a builder for configuring this service.

§Returns

A builder initialized with default worker thread options.

Trait Implementations§

Source§

impl Clone for ThreadPerTaskExecutorService

Source§

fn clone(&self) -> ThreadPerTaskExecutorService

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ThreadPerTaskExecutorService

Source§

fn default() -> Self

Creates a service with default worker options and no hook.

Source§

impl ExecutorService for ThreadPerTaskExecutorService

Source§

fn submit<T, E>(&self, task: T) -> Result<(), SubmissionError>
where T: Runnable<E> + Send + 'static, E: Send + 'static,

Accepts a runnable and starts it on a dedicated OS thread.

§Parameters
  • task - Runnable to execute on a new OS thread.
§Returns

Ok(()) if the runnable was accepted.

§Errors

Returns SubmissionError::Shutdown if shutdown has already been requested before the task is accepted.

Source§

fn submit_callable<C, R, E>( &self, task: C, ) -> Result<Self::ResultHandle<R, E>, SubmissionError>
where C: Callable<R, E> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts a callable and starts it on a dedicated OS thread.

§Parameters
  • task - Callable to execute on a new OS thread.
§Returns

A TaskHandle for the accepted task.

§Errors

Returns SubmissionError::Shutdown if shutdown has already been requested before the task is accepted.

Source§

fn submit_tracked_callable<C, R, E>( &self, task: C, ) -> Result<Self::TrackedHandle<R, E>, SubmissionError>
where C: Callable<R, E> + Send + 'static, R: Send + 'static, E: Send + 'static,

Accepts a callable and starts it with a tracked handle.

Source§

fn shutdown(&self)

Stops accepting new tasks.

Already accepted threads are allowed to finish.

Source§

fn stop(&self) -> StopReport

Stops accepting new tasks and reports currently running work.

Running OS threads cannot be forcefully stopped by this service.

§Returns

A report with zero queued tasks, the observed active thread count, and zero cancelled tasks.

Source§

fn lifecycle(&self) -> ExecutorServiceLifecycle

Returns the current lifecycle state.

Source§

fn wait_termination(&self)

Blocks until all accepted tasks complete after shutdown or stop.

This method blocks the current thread on a condition variable. Calling it while the service is still running will wait until another thread calls Self::shutdown or Self::stop and all accepted OS-thread tasks have completed.

Source§

type ResultHandle<R, E> = TaskHandle<R, E> where R: Send + 'static, E: Send + 'static

Result handle returned for an accepted callable task.
Source§

type TrackedHandle<R, E> = TrackedTask<R, E> where R: Send + 'static, E: Send + 'static

Tracked handle returned for accepted tasks that expose status.
Source§

fn submit_tracked<T, E>( &self, task: T, ) -> Result<Self::TrackedHandle<(), E>, SubmissionError>
where T: Runnable<E> + Send + 'static, E: Send + 'static,

Submits a runnable task and returns a tracked handle. Read more
Source§

fn is_running(&self) -> bool

Returns whether the service accepts new tasks. Read more
Source§

fn is_shutting_down(&self) -> bool

Returns whether graceful shutdown is in progress. Read more
Source§

fn is_stopping(&self) -> bool

Returns whether abrupt stop is in progress. Read more
Source§

fn is_not_running(&self) -> bool

Returns whether this service is not running. Read more
Source§

fn is_terminated(&self) -> bool

Returns whether the service has terminated. Read more

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> 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> DropFlavorWrapper<T> for T

Source§

type Flavor = MayDrop

The DropFlavor that wraps T into Self
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoResult<T> for T

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.