Skip to main content

ProgressJournal

Struct ProgressJournal 

Source
pub struct ProgressJournal {
Show 14 fields pub run_id: String, pub workflow_name: String, pub start_time: DateTime<Utc>, pub last_update: DateTime<Utc>, pub task: String, pub repo: Option<String>, pub branch: Option<String>, pub entries: Vec<ProgressEntry>, pub patterns: Vec<CodebasePattern>, pub decisions: Vec<Decision>, pub risks: Vec<Risk>, pub test_snapshots: Vec<TestSnapshot>, pub build_snapshots: Vec<BuildSnapshot>, pub sections: HashMap<String, String>,
}
Expand description

Progress journal for a workflow run

Fields§

§run_id: String

Workflow run ID

§workflow_name: String

Workflow name

§start_time: DateTime<Utc>

Start time

§last_update: DateTime<Utc>

Last update time

§task: String

Task description

§repo: Option<String>

Repository path

§branch: Option<String>

Branch name

§entries: Vec<ProgressEntry>

All progress entries

§patterns: Vec<CodebasePattern>

Discovered codebase patterns

§decisions: Vec<Decision>

Key decisions

§risks: Vec<Risk>

Identified risks

§test_snapshots: Vec<TestSnapshot>

Test snapshots

§build_snapshots: Vec<BuildSnapshot>

Build snapshots

§sections: HashMap<String, String>

Custom sections

Implementations§

Source§

impl ProgressJournal

Source

pub fn new(run_id: String, workflow_name: String, task: String) -> Self

Create a new progress journal

Source

pub fn add_entry( &mut self, entry_type: EntryType, step_id: &str, title: &str, details: &str, )

Add a progress entry

Source

pub fn add_pattern( &mut self, category: &str, description: &str, example: Option<&str>, reusable: bool, )

Add a codebase pattern

Source

pub fn add_decision( &mut self, title: &str, context: &str, decision: &str, consequences: Vec<String>, reversible: bool, )

Add a decision

Source

pub fn add_risk( &mut self, description: &str, level: RiskLevel, mitigation: Option<&str>, )

Add a risk

Source

pub fn resolve_risk(&mut self, description: &str, notes: &str)

Mark a risk as resolved

Source

pub fn add_test_snapshot( &mut self, command: &str, output: &str, passed: bool, duration_secs: f64, )

Add a test snapshot

Source

pub fn add_build_snapshot( &mut self, command: &str, output: &str, succeeded: bool, duration_secs: f64, )

Add a build snapshot

Source

pub fn set_section(&mut self, name: &str, content: &str)

Set a custom section

Source

pub fn entries_by_type(&self, entry_type: EntryType) -> Vec<&ProgressEntry>

Get entries by type

Source

pub fn to_json(&self) -> Result<String>

Serialize to JSON

Source

pub fn to_markdown(&self) -> String

Serialize to markdown (human-readable)

Source

pub async fn save_to_file(&self, path: &Path) -> Result<()>

Save to file

Source

pub async fn load_from_file(path: &Path) -> Result<Self>

Load from JSON file

Trait Implementations§

Source§

impl Clone for ProgressJournal

Source§

fn clone(&self) -> ProgressJournal

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ProgressJournal

Source§

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

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

impl<'de> Deserialize<'de> for ProgressJournal

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 Serialize for ProgressJournal

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

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
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> 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: 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: 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,