Struct WorkerPool 

pub struct WorkerPool<D, S>
where
    S: WorkerTemplate,
{ /* private fields */ }

WorkerPool manages a pool of worker threads for parallel task execution.

It allows spawning workers, sending data to them, and managing their lifecycle.

Implementations

impl<D: Send + 'static, S: WorkerTemplate> WorkerPool<D, S>

pub fn new(len: u64, template: S, draw_hz: u8) -> Self

Creates a new WorkerPool with a specified number of workers, a worker template, and a draw frequency.

Arguments

• len - The number of workers in the pool.
• template - The template for creating progress bars for each worker.
• draw_hz - The frequency at which the progress bars are drawn (frames per second).

pub fn new_task_id(&self) -> Uid

Generates a new unique task ID.

pub fn spawn_worker<F, Fut>(&mut self, f: F) -> Uid

where Fut: Future<Output = Result<()>> + Send + 'static, Fut::Output: Send + 'static, F: Fn(D, MainProgress<S>) -> Fut + Send + 'static,

Spawns a new worker in the pool.

Arguments

• f - A closure that represents the worker’s task. It takes data D and a MainProgress instance as input and returns a Result.

pub fn main_ui(&self) -> MainProgress<S>

Returns a clone of the main progress instance.

pub async fn sigint(&mut self)

Handles the SIGINT signal, setting a prefix message and stopping all workers.

pub async fn send_seqcst(&mut self, data: D) -> Result<(), D>

Sends data to the first available worker in the pool.

Arguments

• data: The data to send to the worker.

Returns: Result<(), D>

pub async fn send_to(&mut self, id: Uid, data: D) -> Result<(), D>

Sends data directly to the worker by its id.

Arguments

• id - The ID of the worker to send data to.
• data - The data to send.

returns: Result<(), D>

Panics

Panics if the pool naver been spawned a worker.

pub fn thead_count(&self) -> usize

Returns the number of active threads in the pool.

pub async fn join_all(self)

Waits for all workers to complete their tasks.

impl<D: Send, S: WorkerTemplate> WorkerPool<D, S>

pub fn get_style(template: impl AsRef<str>) -> ProgressStyle

Retrieves a ProgressStyle based on the provided template.

This style includes customized progress characters, date formatting, and status indicators.

pub fn println(&self, line: impl AsRef<str>) -> Result<(), Error>

Prints a line to the UI.

pub fn eprintln(&self, line: impl AsRef<str>) -> Result<(), Error>

Prints an error line to the UI.

pub fn horizontal_line(len: usize) -> String

Generates a horizontal line of a specified length.

pub fn vertical_line(len: usize) -> String

Generates a vertical line of a specified length.