Struct LoadStage 

pub struct LoadStage {
    pub stage_type: LoadStageType,
    pub duration_millis: u64,
    pub curve: Option<RampCurve>,
    pub vus: Option<u32>,
    pub start_vus: Option<u32>,
    pub end_vus: Option<u32>,
    pub rate: Option<f64>,
    pub start_rate: Option<f64>,
    pub end_rate: Option<f64>,
    pub max_vus: Option<u32>,
}

One stage of a LoadProfile: a contiguous slice of the run holding or ramping a setpoint for duration_millis. Stages run in sequence. Maps to the LoadStage schema.

Use the constructors LoadStage::vu_hold, LoadStage::vu_ramp, LoadStage::rate_hold, LoadStage::rate_ramp and LoadStage::pause rather than building the struct directly so only the relevant fields are set (and therefore serialized).

Fields

stage_type: LoadStageType

The kind of stage — VU, RATE or PAUSE.

duration_millis: u64

How long this stage runs in milliseconds (> 0).

curve: Option<RampCurve>

Ramp shape (ramp stages only); omitted for holds and pauses.

vus: Option<u32>

VU hold: the number of virtual users to hold for the stage.

start_vus: Option<u32>

VU ramp: virtual users at the start of the ramp.

end_vus: Option<u32>

VU ramp: virtual users at the end of the ramp.

rate: Option<f64>

RATE hold: arrival rate to hold, in iterations per second.

start_rate: Option<f64>

RATE ramp: arrival rate at the start of the ramp, in iterations/second.

end_rate: Option<f64>

RATE ramp: arrival rate at the end of the ramp, in iterations/second.

max_vus: Option<u32>

RATE stage only: optional cap on the auto-scaling virtual-user pool.

Implementations

impl LoadStage

pub fn vu_hold(vus: u32, duration_millis: u64) -> Self

A VU stage holding vus virtual users for duration_millis.

pub fn vu_ramp( start_vus: u32, end_vus: u32, duration_millis: u64, curve: RampCurve, ) -> Self

A VU stage ramping from start_vus to end_vus over duration_millis along curve.

pub fn rate_hold(rate: f64, duration_millis: u64) -> Self

A RATE stage holding rate iterations/second for duration_millis.

pub fn rate_ramp( start_rate: f64, end_rate: f64, duration_millis: u64, curve: RampCurve, ) -> Self

A RATE stage ramping from start_rate to end_rate iterations/second over duration_millis along curve.

pub fn pause(duration_millis: u64) -> Self

A PAUSE stage that drives no load for duration_millis.

pub fn max_vus(self, max_vus: u32) -> Self

Cap the auto-scaling virtual-user pool for this RATE stage.

Trait Implementations

impl Clone for LoadStage

fn clone(&self) -> LoadStage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoadStage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LoadStage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LoadStage

fn eq(&self, other: &LoadStage) -> 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 Serialize for LoadStage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LoadStage