Skip to main content

LifecycleEvent

Enum LifecycleEvent 

Source
pub enum LifecycleEvent {
    Started,
    Resumed {
        from_checkpoint: bool,
    },
    Completed,
}
Expand description

Pipeline lifecycle events (start, stop, resume).

These events control the overall pipeline execution lifecycle, distinct from phase-specific transitions. Use these for:

  • Starting or resuming a pipeline run
  • Completing a successful pipeline execution

§When to Use

  • Started: When a fresh pipeline run begins
  • Resumed: When resuming from a checkpoint
  • Completed: When all phases complete successfully

§⚠️ FROZEN - DO NOT ADD VARIANTS ⚠️

This enum is FROZEN. Adding new variants is PROHIBITED.

§Why is this frozen?

Lifecycle events control pipeline flow (start/stop/completion). Allowing effect handlers to emit new lifecycle events would violate the core architectural principle: handlers describe what happened; reducers decide what happens next.

§What to do instead

If you need to express new observations or failures:

  1. Reuse existing phase/category events - Use PlanningEvent, DevelopmentEvent, ReviewEvent, CommitEvent, etc. to describe what happened within that phase. Example: PlanningEvent::PlanXmlMissing instead of creating a generic “Aborted” event.

  2. Return errors from the event loop - For truly unrecoverable failures (permission errors, invariant violations), return Err from the effect handler. The outer runner will handle termination, not the reducer.

  3. Handle in orchestration - Some conditions don’t need events at all and can be handled in the effect handler or runner logic.

§Enforcement

The freeze policy is enforced by the lifecycle_event_is_frozen test in this module, which will fail to compile if new variants are added. This is intentional.

Variants§

§

Started

Pipeline execution started fresh (not from checkpoint).

§

Resumed

Pipeline execution resumed from a previous state.

Fields

§from_checkpoint: bool

Whether this resume is from a persisted checkpoint.

§

Completed

Pipeline execution completed successfully.

Trait Implementations§

Source§

impl Clone for LifecycleEvent

Source§

fn clone(&self) -> LifecycleEvent

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 LifecycleEvent

Source§

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

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

impl<'de> Deserialize<'de> for LifecycleEvent

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 LifecycleEvent

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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,