Struct Projection 

pub struct Projection {
    pub scope: AnalyticsScope,
    pub mode: Mode,
    pub unit: Option<String>,
    pub as_of: String,
    pub end_date: String,
    pub remaining: Option<i64>,
    pub observed_rate: Option<f64>,
    pub projected_completion: Option<String>,
    pub meets_end_date: Option<bool>,
    pub status: ProjectionStatus,
    pub formula_version: String,
    pub diagnostics: Vec<AnalyticsDiagnostic>,
}

The read-only end-date forecast over one series (data-model §5).

observed_rate and remaining are in the series’ own unit — the counts of count mode, or the converted units of estimate mode — which mode/unit carry so a reader never sees a rate without the unit it is expressed in.

The type holds an AnalyticsScope (and therefore no serde derive, like BurndownSeries): the chart document either derives these types at the export layer or mirrors them there.

Fields

scope: AnalyticsScope

The selected cycle/milestone, period and snapshot binding.

mode: Mode

How the series the projection was drawn from counts.

unit: Option<String>

The unit the remaining work and the rate are expressed in, in estimate mode.

as_of: String

The forecast origin — the caller’s day, never a clock.

end_date: String

The planning end date the forecast is drawn against, as the caller supplied it.

remaining: Option<i64>

The remaining work the series carried to as_of, in the series’ unit.

observed_rate: Option<f64>

The observed completion rate, in the series’ unit per calendar day.

projected_completion: Option<String>

The forecast completion date, when one follows.

meets_end_date: Option<bool>

Whether the projected completion falls on or before end_date; None when no date was projected.

status: ProjectionStatus

Whether the projection could answer, and with what.

formula_version: String

The documented formula this projection was drawn under.

diagnostics: Vec<AnalyticsDiagnostic>

Why no date was projected, when one was not.

Implementations

impl Projection

pub fn is_projected(&self) -> bool

Whether a completion date was derived.

pub fn projected_completion(&self) -> Option<&str>

The projected completion date, when one was derived.

Trait Implementations

impl Clone for Projection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Projection

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

Formats the value using the given formatter.

impl PartialEq for Projection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Projection