Skip to main content

Plan

Struct Plan 

Source
pub struct Plan {
    pub project: PlanProject,
    pub statuses: PlanVocabulary,
    pub milestones: Vec<PlanMilestone>,
    pub issues: Vec<PlanIssue>,
    pub waves: Vec<PlanWave>,
    pub edges: Vec<PlanEdge>,
    pub milestone_edges: Vec<PlanEdge>,
    pub findings: Vec<PlanFinding>,
}
Expand description

The whole derived plan: what every plan capability answers out of.

Fields§

§project: PlanProject

The plan’s header, with the active milestone derived.

§statuses: PlanVocabulary

The declared status vocabularies.

§milestones: Vec<PlanMilestone>

Every milestone, in id order.

§issues: Vec<PlanIssue>

Every issue, in id order.

§waves: Vec<PlanWave>

The execution waves, lowest first.

§edges: Vec<PlanEdge>

The issue dependency graph, sorted.

§milestone_edges: Vec<PlanEdge>

The milestone dependency graph, sorted.

§findings: Vec<PlanFinding>

Every finding, in derivation order.

Implementations§

Source§

impl Plan

Source

pub fn issue(&self, id: &str) -> Option<&PlanIssue>

One issue by id.

Source

pub fn milestone(&self, id: &str) -> Option<&PlanMilestone>

One milestone by id.

Source

pub fn failures(&self) -> usize

How many findings are failures. A model with one is invalid.

Source

pub fn warnings(&self) -> usize

How many findings are warnings.

Source

pub fn is_present(&self) -> bool

Whether this repository holds a canonical project model at all.

Source

pub fn roadmap(&self) -> Vec<&PlanMilestone>

The milestone ids in roadmap order: rank, then order, then id. Derived from the graph; no list of versions is maintained anywhere.

Source

pub fn next_ready(&self, milestone: Option<&str>) -> Option<&PlanIssue>

The one issue a worker should take now: the lowest-wave READY issue of the active milestone, highest priority first, then id.

The active milestone can have nothing ready while another one does — a milestone waiting on its own acceptance evidence, for instance — so the search widens to the whole plan rather than answering “none” and sending a worker away from executable work. mj_pj_next_ready in lib/project.sh does exactly this.

Source

pub fn build(index: &Index) -> Plan

Build the plan from an index. A walk of values already in memory: no file is opened, no subprocess is started, nothing is cached.

Source

pub fn after(index: &Index, id: &str, transition: Transition, now: &str) -> Plan

The plan as it will read once transition has been written to id.

The same records, the same derive, one timestamp changed: the status a caller is told after a write is computed by the one derivation every reader uses, never announced by the writer. This matters because the resulting status is not a function of the transition alone — a done whose required evidence is absent stays VERIFY, and a record marked cancelled stays CANCELLED whatever is written to it.

Nothing is read from disk and nothing is written: this is the projection of a write, and transition is what performs one.

use majordomus_cli::plan::{Plan, Transition};
let before = Plan::build(index);
let after = Plan::after(index, "I0001", Transition::Done, "2026-09-11T12:00:00Z");
// The status is derived both times, so an issue whose evidence is incomplete is
// still VERIFY afterwards and the caller can see that before writing anything.
assert_eq!(before.issue("I0001").is_some(), after.issue("I0001").is_some());

Trait Implementations§

Source§

impl Clone for Plan

Source§

fn clone(&self) -> Plan

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 Plan

Source§

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

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

impl<'de> Deserialize<'de> for Plan

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Plan

Source§

impl JsonSchema for Plan

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Plan

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Plan

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Plan

Auto Trait Implementations§

§

impl Freeze for Plan

§

impl RefUnwindSafe for Plan

§

impl Send for Plan

§

impl Sync for Plan

§

impl Unpin for Plan

§

impl UnsafeUnpin for Plan

§

impl UnwindSafe for Plan

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more