Skip to main content

Goal

Struct Goal 

Source
pub struct Goal {
    pub schema: String,
    pub id: String,
    pub objective: String,
    pub context: Vec<PathBuf>,
    pub posture: String,
    pub invariants: Vec<String>,
    pub phases: Vec<Phase>,
    pub verify: String,
    pub created_ms: i64,
    pub updated_ms: i64,
}
Expand description

A durable, resumable objective.

Fields§

§schema: String§id: String

Stable across resumes. The thing a log line can point at.

§objective: String

One outcome. Not a list — a goal that wants three things is three goals, and the single objective is what makes “what was this run for?” answerable months later.

§context: Vec<PathBuf>

Paths to read, not their contents. See the module docs.

§posture: String

How to work: cautious, exploratory, ship-it. Free text, because the useful values differ per team and an enum would just be ignored.

§invariants: Vec<String>

What must not change. Stated separately from the objective because the model reads the objective as an instruction and these as a boundary.

§phases: Vec<Phase>§verify: String

How completion is checked, in words. The executable form is an crate::Acceptance; this is what a human reads to know what that check is supposed to be enforcing.

§created_ms: i64§updated_ms: i64

Implementations§

Source§

impl Goal

Source

pub fn new( id: impl Into<String>, objective: impl Into<String>, now_ms: i64, ) -> Self

Source

pub fn with_context<I, P>(self, paths: I) -> Self
where I: IntoIterator<Item = P>, P: Into<PathBuf>,

Source

pub fn with_posture(self, p: impl Into<String>) -> Self

Source

pub fn with_invariants<I, S>(self, items: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn with_phases<I, S>(self, titles: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Source

pub fn with_verify(self, v: impl Into<String>) -> Self

Source

pub fn current(&self) -> Option<(usize, &Phase)>

The phase to work on: the one running, else the first not yet done.

A Failed phase is returned again rather than skipped — the run stopped there for a reason and resuming past it would quietly abandon work the goal still claims to want.

Source

pub fn complete(&self) -> bool

Every phase is Done. A goal with no phases is never complete: it has not been broken down, so there is nothing to have finished.

Source

pub fn start_current(&mut self, now_ms: i64) -> Option<usize>

Mark the current phase as in flight.

Source

pub fn finish(&mut self, i: usize, note: impl Into<String>, now_ms: i64)

Source

pub fn fail(&mut self, i: usize, why: impl Into<String>, now_ms: i64)

Source

pub fn brief(&self) -> String

Render the brief for the current phase.

Includes the objective every time. A model resuming at phase 9 has none of the earlier conversation, and a phase title on its own (“wire the handler”) is not a task — it is a reminder to someone who already knew.

Trait Implementations§

Source§

impl Clone for Goal

Source§

fn clone(&self) -> Goal

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 Goal

Source§

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

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

impl<'de> Deserialize<'de> for Goal

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 Goal

Source§

impl PartialEq for Goal

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Goal

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 Goal

Auto Trait Implementations§

§

impl Freeze for Goal

§

impl RefUnwindSafe for Goal

§

impl Send for Goal

§

impl Sync for Goal

§

impl Unpin for Goal

§

impl UnsafeUnpin for Goal

§

impl UnwindSafe for Goal

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> 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 ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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