Skip to main content

CapacityCommand

Enum CapacityCommand 

Source
pub enum CapacityCommand {
    List,
    Show {
        reference: String,
        scope: Option<String>,
    },
    Set {
        scope: String,
        id: String,
        value: i64,
        unit: String,
        disabled: bool,
    },
    Delete {
        scope: String,
        id: String,
    },
    Calculate {
        scope: String,
        id: String,
        warnings: bool,
    },
    Snapshot {
        cycle: String,
        warnings: bool,
    },
}

Variants§

§

List

List every configured ceiling, one tab-separated row per entry

Columns: id, scope, reference, display, capacity, unit, enabled. The header prints even with no entries, so an empty section is visibly empty rather than indistinguishable from a failure.

§

Show

Show one ceiling by the reference it names

A reference is a cycle’s name or stable id, a team label, or an assignee identity; --scope narrows it when one reference names two scopes.

Fields

§reference: String

Cycle name/stable id, team label, or assignee identity

§scope: Option<String>

Restrict the match to one scope: cycle, team or assignee

§

Set

Set one scope’s ceiling; validated before persistence

The scope and the unit are explicit: a value with no unit, a unit no board declares, an unknown cycle/team, or a second ceiling for one scope is refused before tix.toml changes.

Fields

§scope: String

Scope dimension: cycle, team or assignee

§id: String

The scope’s reference (a cycle name or stable id, a team label, an identity)

§value: i64

The ceiling, in --unit, at or above zero

A negative value is accepted by the parser and refused by the shared validator with its field path (capacity.<id>.capacity), which is a better message than clap’s “unexpected argument”.

§unit: String

The estimate unit the ceiling counts in (declared by the active board)

§disabled: bool

Keep the value and the unit, but enforce nothing

§

Delete

Delete one scope’s ceiling

Fields

§scope: String

Scope dimension: cycle, team or assignee

§id: String

The scope’s reference (a cycle name or stable id, a team label, an identity)

§

Calculate

Calculate one scope’s committed/completed/remaining/overflow/utilization

Every value comes from the shared calculation DTO; a value the calculation could not derive prints as -, never as a zero. Findings go to stderr.

Fields

§scope: String

Scope dimension: cycle, team or assignee

§id: String

The scope’s reference (a cycle name or stable id, a team label, an identity)

§warnings: bool

Also render the overflow report (estimate and reference findings always render)

§

Snapshot

Read back a closed cycle’s immutable capacity evidence

Fields

§cycle: String

Cycle name or stable <schedule-id>:<sequence> id

§warnings: bool

Also render the overflow finding the close recorded

Trait Implementations§

Source§

impl Clone for CapacityCommand

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 CapacityCommand

Source§

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

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

impl FromArgMatches for CapacityCommand

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 CapacityCommand

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.