Struct AnalyticsScope 

pub struct AnalyticsScope {
    pub kind: ScopeKind,
    pub id: String,
    pub period: Period,
    pub snapshot_id: Option<String>,
}

The selected cycle/milestone and its period context (data-model.md §1).

The snapshot_id is the closed-series binding: when it is present the scope refers to a closed historical view, and events after the period’s end are not contributions to it (C-006 — a later edit never rewrites a closed series).

Fields

kind: ScopeKind

Which planning entity the id names.

id: String

The stable planning identity (a cycle name, a milestone name).

period: Period

The inclusive period context.

snapshot_id: Option<String>

The closed snapshot this series is bound to, when it is bound to one.

Implementations

impl AnalyticsScope

pub fn new( kind: ScopeKind, id: impl Into<String>, period: Period, ) -> Result<Self>

A scope. A blank id is refused: an unnamed scope cannot be reported or compared, and defaulting it would hide the caller’s mistake.

pub fn cycle(id: impl Into<String>, period: Period) -> Result<Self>

A cycle scope.

pub fn milestone(id: impl Into<String>, period: Period) -> Result<Self>

A milestone scope.

pub fn with_snapshot_id(self, snapshot_id: impl Into<String>) -> Self

Bind this scope to a closed snapshot’s stable identity (C-006).

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

The inclusive period start, when the planning data declares one.

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

The inclusive period end, when the planning data declares one.

pub fn is_closed(&self) -> bool

Whether this scope is closed: bound to a snapshot or bounded by an end date.

A closed scope’s series stops at its period, which is what keeps a later edit from extending a historical view.

pub fn contains(&self, date: &str) -> bool

Whether date belongs to this scope’s period. An event with no readable day is handled by EventIndex::contribute, not here.

Trait Implementations

impl Clone for AnalyticsScope

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 AnalyticsScope

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

Formats the value using the given formatter.

impl Display for AnalyticsScope

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

Formats the value using the given formatter.

impl Eq for AnalyticsScope

impl PartialEq for AnalyticsScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnalyticsScope