Struct PhaseSpec 

#[non_exhaustive]
pub struct PhaseSpec<'a> {
    pub name: &'a str,
    pub weight: u64,
    pub total: Total,
    pub units: &'a str,
    pub execution: Execution,
}

One child in a split: a name, a weight relative to its siblings, a total, and optionally a unit name and an execution model.

Weights are relative, so [35, 30, 35] gives the middle child exactly 30% of its parent however many workers it later uses. Build it with PhaseSpec::new; the fields stay readable, and new planning options can be added without breaking existing code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: &'a str

Human-readable phase name.

weight: u64

Positive weight relative to the siblings.

total: Total

Denominator for this phase’s completed units.

units: &'a str

Name of the counted unit, such as rows or superblocks.

execution: Execution

How this phase’s work is scheduled.

Implementations

impl<'a> PhaseSpec<'a>

pub const fn new(name: &'a str, weight: u64, total: Total) -> Self

Describe one weighted child that counts items.

pub const fn units(self, units: &'a str) -> Self

Name the counted unit.

pub const fn execution(self, execution: Execution) -> Self

Declare how this phase’s work is scheduled.

pub fn validate_split(parts: &[PhaseSpec<'_>]) -> Result<u64, PlanError>

Check a split’s parts the way every Pulse::split must, and return the sum of their weights.

Fails with PlanError::EmptyOrZeroWeight for no parts or a zero weight, and PlanError::Overflow if the weights’ sum overflows. Call it first in a split implementation, so every pulse rejects the same plans with the same errors.

Trait Implementations

impl<'a> Clone for PhaseSpec<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PhaseSpec<'a>

impl<'a> Debug for PhaseSpec<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for PhaseSpec<'a>

impl<'a> PartialEq for PhaseSpec<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for PhaseSpec<'a>