Struct CapacityEntry 

pub struct CapacityEntry {
    pub cycle: Option<String>,
    pub team: Option<String>,
    pub assignee: Option<String>,
    pub capacity: Option<i64>,
    pub unit: Option<String>,
    pub enabled: bool,
    pub extensions: CapacityExtensions,
}

One capacity ceiling, for exactly one scope.

The three scope keys are Option<String> on purpose: “absent” has to be distinguishable from “set”, because an entry that names no scope is refused by name (C-003) rather than guessed from the surrounding table. capacity is i64 rather than an unsigned integer so that a negative number is refused with its field path instead of failing in the TOML parser, where no diagnostic could name the record.

Fields

cycle: Option<String>

The cycle this ceiling belongs to: the name a [cycles.<name>] record answers to, or a generated cycle’s stable id. See resolve_cycle.

team: Option<String>

The team this ceiling belongs to: a [teams.<label>] key.

assignee: Option<String>

The assignee this ceiling belongs to: an identity in the shape an issue’s assignee field tolerates (a handle, or Name <email>).

capacity: Option<i64>

The ceiling itself, at or above zero, counted in unit.

Required for an enabled entry; a disabled entry may omit it, which is how a scope stays configured without a ceiling in force.

unit: Option<String>

The estimate unit capacity counts in. Required for an enabled entry, refused when blank, and refused when no board declares it.

enabled: bool

Whether the ceiling is in force. false keeps the numbers for later without changing today’s calculations.

extensions: CapacityExtensions

Unknown metadata, preserved verbatim.

Implementations

impl CapacityEntry

pub fn scopes(&self) -> impl Iterator<Item = (CapacityScopeKind, &str)>

The (kind, reference) this entry names, in scope-kind order.

Zero entries means “no scope”, more than one means “ambiguous”; both are refused by validate. A caller that has validated a config always gets exactly one.

pub fn scope_kind(&self) -> Option<CapacityScopeKind>

The scope kind this entry names, when it names exactly one.

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

The scope reference this entry names, when it names exactly one.

pub fn effective(&self) -> bool

Whether the ceiling is in force: enabled, with a value and a unit.

The resolver every surface should ask, so “declared but disabled” cannot be read as “enforced” by one caller and not another — the same rule crate::wip::config::WipConfig::effective_limit follows for limits.

Trait Implementations

impl Clone for CapacityEntry

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 CapacityEntry

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

Formats the value using the given formatter.

impl Default for CapacityEntry

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CapacityEntry

where CapacityEntry: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CapacityEntry

impl PartialEq for CapacityEntry

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CapacityEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CapacityEntry