Struct xstream_util::Limiting

pub struct Limiting<C> { /* private fields */ }

A pool to manage spawning a limited number of processses

This will wait for the oldest scheduled process to complete before scheduling a new one. If you schedule a long running process, then a bunch of short ones, it won’t schedule more short ones beyond the buffer until the long one has finished.

Implementations

impl<C: BorrowMut<Command>> Limiting<C>

pub fn new(command: C, max_procs: usize) -> Self

Create a new empty pool with a limited number of total processes

Set max_procs to 0 to enable unbounded parallelism.

Trait Implementations

impl<C: Debug> Debug for Limiting<C>

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

Formats the value using the given formatter.

impl<C> Drop for Limiting<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: BorrowMut<Command>> Pool for Limiting<C>

fn get(&mut self) -> Result<&mut Child, Error>

Spawn a new process with command and return a mutable reference to the process

This command will block until it can schedule the process under the constraints. It can fail for any reason, including an earlier process failed, and never actually spawn the process in question. If it does successfully spawn the process, it will be recorded so that it will be cleaned up if the pool is dropped.

fn join(&mut self) -> Result<(), Error>

Wait for all processes to finish

Errors will terminate early and not wait for reamining processes to finish. To continue waiting for them anyway you can continue to call join until you get a success, this will indicate that there are no more running processes under management by the pool.