Enum LifecycleOutcome 

pub enum LifecycleOutcome {
    Applied {
        action: LifecycleAction,
        schedule_id: CycleScheduleId,
        cycle_id: Option<GeneratedCycleId>,
        snapshot_path: Option<String>,
        dates: Option<(String, String)>,
        message: String,
    },
    NoOp {
        action: LifecycleAction,
        schedule_id: CycleScheduleId,
        cycle_id: Option<GeneratedCycleId>,
        message: String,
    },
    Rejected {
        action: LifecycleAction,
        schedule_id: CycleScheduleId,
        cycle_id: Option<GeneratedCycleId>,
        diagnostics: Vec<LifecycleDiagnostic>,
    },
}

What one confirmed lifecycle action did (data-model.md §6, T029).

Exactly one of three shapes, each a result rather than an error, so a surface reports it instead of catching it. Exactly one outcome per action.

Variants

Applied

The action changed something. snapshot_path is present on a close that captured one, and dates on an action that moved a window.

Fields

action: LifecycleAction

The action that was carried out.

schedule_id: CycleScheduleId

The schedule it acted on.

cycle_id: Option<GeneratedCycleId>

The instance it acted on, when it named one.

snapshot_path: Option<String>

The captured snapshot, project-relative, when one was written.

dates: Option<(String, String)>

The resulting (start_date, due_date), when the action moved a window.

message: String

One sentence for a surface.

NoOp

The action’s postcondition already held; nothing was written.

Fields

action: LifecycleAction

The action that was requested.

schedule_id: CycleScheduleId

The schedule it named.

cycle_id: Option<GeneratedCycleId>

The instance it named, when it named one.

message: String

One sentence saying why nothing was written.

Rejected

The action was refused. Nothing was written.

Fields

action: LifecycleAction

The action that was requested.

schedule_id: CycleScheduleId

The schedule it named.

cycle_id: Option<GeneratedCycleId>

The instance it named, when it named one.

diagnostics: Vec<LifecycleDiagnostic>

Every reason, in the order they were found.

Implementations

impl LifecycleOutcome

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

The stable word a surface prints: applied, no-op or rejected.

pub fn is_applied(&self) -> bool

Whether something was written.

pub fn is_noop(&self) -> bool

Whether the postcondition already held.

pub fn is_rejected(&self) -> bool

Whether the action was refused.

pub fn action(&self) -> LifecycleAction

The action the outcome is about.

pub fn schedule_id(&self) -> &CycleScheduleId

The schedule the outcome is about.

pub fn cycle_id(&self) -> Option<&GeneratedCycleId>

The instance the outcome concerns, when it concerns one.

pub fn snapshot_path(&self) -> Option<&str>

The captured snapshot, project-relative, present on an applied close.

pub fn dates(&self) -> Option<&(String, String)>

The resulting dates, present on an action that moved a window.

pub fn diagnostics(&self) -> &[LifecycleDiagnostic]

Every diagnostic, empty for applied and no-op.

pub fn render(&self) -> String

One line for a surface.

Trait Implementations

impl Clone for LifecycleOutcome

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LifecycleOutcome

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

Formats the value using the given formatter.

impl Eq for LifecycleOutcome

impl PartialEq for LifecycleOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LifecycleOutcome