Skip to main content

AnalyticsCommand

Enum AnalyticsCommand 

Source
pub enum AnalyticsCommand {
    Burndown {
        args: AnalyticsScopeArgs,
    },
    Projection {
        args: AnalyticsScopeArgs,
        as_of: String,
    },
    Export {
        args: AnalyticsScopeArgs,
        as_of: Option<String>,
        output: Option<String>,
    },
}
Expand description

The tix analytics subcommands (mission burndown-scope-analytics-01M3C9J1, WP05).

A thin adapter over the shared analytics DTOs. The daily fold, the unit conversion and the projection live in crate::analytics, and the versioned chart document is WP04’s (crate::commands::export::chart_document), which every verb here calls rather than re-composing. This enum owns only the spelling of the surface: the scope, the period and the mode/unit are always explicit, and no flag here can change an issue, a cycle date, a milestone or a snapshot.

Variants§

§

Burndown

Print the daily remaining/completed series for one cycle or milestone

A tab-separated table with a date column followed by the point’s own fields — scope_total, remaining, completed, scope_added, completions — and the day’s coverage. A value the record cannot support is -, never a zero, and a day with no recorded history is unknown or coverage_limited. The scope, period, mode, unit, formula version and coverage tally print above the header row, and the findings render to stderr with their remedies.

§

Projection

Print the read-only end-date forecast over one cycle or milestone

The planning end date is the scope’s own (--to overrides it) and --as-of is the caller’s day, never a clock. A forecast the record cannot answer prints its status (insufficient_data or unknown) with - for every value it could not derive — no completion date is ever invented, and no planning date or issue changes.

Fields

§as_of: String

The forecast origin, a YYYY-MM-DD calendar date

§

Export

Write the deterministic local chart document (WP04’s target)

The document goes to stdout, or to --output through the atomic export writer the other local targets use. --mode is required: the document states the mode it was folded in, so a default would be a guess about which arithmetic produced the numbers. --as-of asks the same document for a forecast. The remote gitlab/linear namespaces are never consulted and cannot collide with a chart document.

Fields

§as_of: Option<String>

Ask the document for a forecast at this origin, a YYYY-MM-DD calendar date

§output: Option<String>

Write the document to this path instead of stdout

Trait Implementations§

Source§

impl Clone for AnalyticsCommand

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AnalyticsCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for AnalyticsCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for AnalyticsCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.