Struct Obligation 

pub struct Obligation {
    pub id: GovernanceLogId,
    pub created_at: DateTime<Utc>,
    pub chain_seq: u64,
    pub data: ObligationData,
    pub state: ObligationState,
}

An obligation (OBL-…): the signed entry as the log has it now, its latest version and what its amendments add up to.

The one type for an obligation. What was signed (ObligationData) and what it adds up to (ObligationState) are kept apart inside it on purpose: the first is covered by a signature and never changes but by a revision; the second is derived and does, and must never be signed by mistake. Everything else (the to-do list’s rows, the calendar’s deadlines, the serving types) is derived from this.

Fields

id: GovernanceLogId

created_at: DateTime<Utc>

chain_seq: u64

data: ObligationData

Its latest version, every revision applied

state: ObligationState

What its amendments add up to

Implementations

impl Obligation

pub fn from_log( id: GovernanceLogId, created_at: DateTime<Utc>, chain_seq: u64, data: &Value, amendments: &[(DateTime<Utc>, Amendment)], ) -> Result<Self, ObligationError>

The entry id with its stored data, after amendments: those naming it, with their created_at, in chain order. Revisions are applied to data for the latest version, and the state is folded from all of them (ObligationState::from_amendments).

pub fn awaited_decision(&self) -> Option<&GovernanceLogId>

The after_decision decision its current deadline waits on: what a server looks up before crate::calendar::ResolvedObligation::new

impl Obligation

pub fn check_amendment( &self, amendment: &Amendment, entry: impl Fn(&GovernanceLogId) -> Option<KnownEntry>, ) -> Result<(), ObligationRuleError>

Whether amendment may be appended to this obligation as it now stands. entry looks up an entry of the log by id.

The rules (agora docs/design-obligations.md):

• planned: anyone may record one;
• discharged: the Steward’s for Steward- and staff-owed obligations; a Council-owed one needs a Council decision as authority;
• lapsed: only a dated, open obligation lapses;
• rescheduled, withdrawn: by whoever set the deadline. If a Council decision did (the source, or the authority of the last reschedule), authority must be a Council decision. A Council-owed obligation is withdrawn only by the Council;
• a revision never touches OBLIGATION_FIXED. One that narrows text is a partial discharge: if the Council owes the obligation or set its deadline, it needs a Council decision too. Its other fields are clerical.

A Council decision that authorizes anything here is later than the obligation and than the decision that set its deadline. Nothing but a revision or another non-obligation kind amends a closed obligation, and those kinds are otherwise not this method’s business.

Trait Implementations

impl Clone for Obligation

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 Obligation

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

Formats the value using the given formatter.

impl Eq for Obligation

impl PartialEq for Obligation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Obligation