Struct ScatterConfig 

pub struct ScatterConfig {
    pub concurrency: Option<u64>,
}

Represents scatter statement evaluation configuration.

Fields

concurrency: Option<u64>

The number of scatter array elements to process concurrently.

Defaults to 1000.

A value of 0 is invalid.

Lower values use less memory for evaluation and higher values may better saturate the task execution backend with tasks to execute for large scatters.

This setting does not change how many tasks an execution backend can run concurrently, but may affect how many tasks are sent to the backend to run at a time.

For example, if concurrency was set to 10 and we evaluate the following scatters:

scatter (i in range(100)) {
    call my_task
}

scatter (j in range(100)) {
    call my_task as my_task2
}

Here each scatter is independent and therefore there will be 20 calls (10 for each scatter) made concurrently. If the task execution backend can only execute 5 tasks concurrently, 5 tasks will execute and 15 will be “ready” to execute and waiting for an executing task to complete.

If instead we evaluate the following scatters:

scatter (i in range(100)) {
    scatter (j in range(100)) {
        call my_task
    }
}

Then there will be 100 calls (10*10 as 10 are made for each outer element) made concurrently. If the task execution backend can only execute 5 tasks concurrently, 5 tasks will execute and 95 will be “ready” to execute and waiting for an executing task to complete.

Warning: nested scatter statements cause exponential memory usage based on this value, as each scatter statement evaluation requires allocating new scopes for scatter array elements being processed.

Implementations

impl ScatterConfig

pub fn validate(&self) -> Result<()>

Validates the scatter configuration.

Trait Implementations

impl Clone for ScatterConfig

fn clone(&self) -> ScatterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScatterConfig

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

Formats the value using the given formatter.

impl Default for ScatterConfig

fn default() -> ScatterConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScatterConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScatterConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.