Struct WorkerOptions

pub struct WorkerOptions {
    pub pipe_buffer_size: usize,
    pub max_task_count: usize,
}

Options that can be passed to methods in the PipelineBuilder when defining stages.

This implements Default which makes it easier to specify options when defining stages. By default, each worker will be allowed 100 concurrent tasks maximum and the buffer of each pipe is set to 30.

Examples

use async_pipes::{Pipeline, WorkerOptions};

#[tokio::main]
async fn main() {
    let pipeline = Pipeline::builder()
        .with_inputs("Pipe", vec![()])
        .with_consumer("Pipe", WorkerOptions::default(), |_: ()| async move {
            /* ... */
        })
        .build();

    assert!(pipeline.is_ok());
}

Fields

pipe_buffer_size: usize

The maximum number of items allowed per pipe before stages have to wait to write more data to the pipe.

max_task_count: usize

The maximum number of tasks that a worker can be concurrently running. Once this number is reached in a worker, the worker will poll for tasks completions before spawning more.

Implementations

impl WorkerOptions

pub fn default_single_task() -> Self

Like the Default implementation, but specifies 1 for WorkerOptions::max_task_count.

pub fn default_multi_task() -> Self

Specifies 100 for WorkerOptions::max_task_count and 30 for WorkerOptions::pipe_buffer_size.

Trait Implementations

impl Clone for WorkerOptions

fn clone(&self) -> WorkerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkerOptions

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

Formats the value using the given formatter.

impl Default for WorkerOptions

fn default() -> Self

Returns the “default value” for a type.

impl Hash for WorkerOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WorkerOptions

fn cmp(&self, other: &WorkerOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WorkerOptions

fn eq(&self, other: &WorkerOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for WorkerOptions

fn partial_cmp(&self, other: &WorkerOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for WorkerOptions

impl StructuralPartialEq for WorkerOptions