Skip to main content

TaskReadiness

Enum TaskReadiness 

Source
pub enum TaskReadiness {
    Ready,
    Blocked,
    Waiting,
    InProgress,
    Review,
    CompletionBlocked,
    Complete,
    Cancelled,
    Undeclared,
}
Expand description

Where a development task stands, as work.

use majordomus_cli::devtask::TaskReadiness;

// every state names the canonical status it refines, and refines only one
assert_eq!(TaskReadiness::Ready.canonical(), "READY");
assert_eq!(TaskReadiness::Waiting.canonical(), "BLOCKED");
assert_eq!(TaskReadiness::Blocked.canonical(), "BLOCKED");
assert_eq!(TaskReadiness::Review.canonical(), "VERIFY");
assert_eq!(TaskReadiness::CompletionBlocked.canonical(), "VERIFY");

// and one state is the absence of a record rather than a status of one
assert!(TaskReadiness::Undeclared.canonical().is_empty());

Variants§

§

Ready

Nothing holds it back and nobody has started it. Canonical READY.

§

Blocked

At least one issue it depends on is not DONE. Canonical BLOCKED.

§

Waiting

Every issue dependency is satisfied; the milestone gate holds it. Canonical BLOCKED, and a distinct situation because it is resolved in another milestone.

§

InProgress

Execution began: the record carries started_at. Canonical ACTIVE.

§

Review

Implementation is declared finished and completion has not been recorded: the record carries verified_at. Canonical VERIFY.

§

CompletionBlocked

Completion was recorded and the evidence the record itself requires is not all there, so the plan refuses to call it DONE. Canonical VERIFY, and the case the evidence_missing finding is about.

§

Complete

Finished on its own terms: not cancelled, completion recorded, every required evidence token present. Canonical DONE.

§

Cancelled

Withdrawn. Canonical CANCELLED.

§

Undeclared

The canonical model does not declare this id. Not a status: the absence of a record.

Implementations§

Source§

impl TaskReadiness

Source

pub const ALL: &'static [TaskReadiness]

Every state, in the order a board reads them: the executable ones first, the finished ones last. Declared once so that no surface writes the sequence down.

Source

pub fn canonical(self) -> &'static str

The canonical status this refines, or the empty string for TaskReadiness::Undeclared, which refines none.

Source

pub fn as_str(self) -> &'static str

The word a projection prints.

Source

pub fn is_startable(self) -> bool

May a worker pick this up right now?

use majordomus_cli::devtask::TaskReadiness;
assert!(TaskReadiness::Ready.is_startable());
assert!(!TaskReadiness::InProgress.is_startable(), "somebody already has it");
Source

pub fn is_terminal(self) -> bool

Is there nothing further to do, whatever happens elsewhere?

Source

pub fn derive( status: &str, blockers: &[String], completion_recorded: bool, evidence_covered: bool, ) -> TaskReadiness

Derive the readiness from the facts the plan already holds.

The arguments are exactly what crate::plan derives and what the canonical record declares; nothing is read here, and nothing is guessed. status is the canonical status, blockers the plan’s own blocked_by list — whose milestone: prefix is what separates TaskReadiness::Waiting from TaskReadiness::Blocked — and completion_recorded / evidence_covered are what separate TaskReadiness::CompletionBlocked from TaskReadiness::Review.

use majordomus_cli::devtask::TaskReadiness;

// blocked only by its milestone is waiting, not blocked
let waiting = TaskReadiness::derive("BLOCKED", &["milestone:m1".to_string()], false, true);
assert_eq!(waiting, TaskReadiness::Waiting);

// blocked by a peer, milestone gate or not, is blocked
let blocked = TaskReadiness::derive(
    "BLOCKED",
    &["I0002".to_string(), "milestone:m1".to_string()],
    false,
    true,
);
assert_eq!(blocked, TaskReadiness::Blocked);

// completion recorded without the evidence it requires
let stuck = TaskReadiness::derive("VERIFY", &[], true, false);
assert_eq!(stuck, TaskReadiness::CompletionBlocked);

// verified and waiting to be closed
assert_eq!(TaskReadiness::derive("VERIFY", &[], false, false), TaskReadiness::Review);

// a status the plan never derives is not silently mapped onto one that looks fine
assert_eq!(TaskReadiness::derive("NONESUCH", &[], false, false), TaskReadiness::Undeclared);

Trait Implementations§

Source§

impl Clone for TaskReadiness

Source§

fn clone(&self) -> TaskReadiness

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 Copy for TaskReadiness

Source§

impl Debug for TaskReadiness

Source§

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

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

impl<'de> Deserialize<'de> for TaskReadiness

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 TaskReadiness

Source§

impl Hash for TaskReadiness

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl JsonSchema for TaskReadiness

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 Ord for TaskReadiness

Source§

fn cmp(&self, other: &TaskReadiness) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for TaskReadiness

Source§

fn eq(&self, other: &TaskReadiness) -> 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 PartialOrd for TaskReadiness

Source§

fn partial_cmp(&self, other: &TaskReadiness) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for TaskReadiness

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 TaskReadiness

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
§

impl<T> AsOut<T> for T
where T: Copy,

§

fn as_out(&mut self) -> Out<'_, T>

Returns an out reference to self.
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
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
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