Struct LifecycleRequest 

pub struct LifecycleRequest {
    pub series_id: SeriesId,
    pub action: LifecycleAction,
    pub occurrence_key: Option<OccurrenceKey>,
    pub actor: String,
    pub reason: Option<String>,
    pub confirmed: bool,
}

One confirmed lifecycle action on one series (T023/T024).

Fields

series_id: SeriesId

The series to act on.

action: LifecycleAction

Which action.

occurrence_key: Option<OccurrenceKey>

The occurrence key, required by skip/defer/ignore.

actor: String

Who acted; lands in the History entry.

reason: Option<String>

Why, when the caller gave one.

confirmed: bool

Whether the caller confirmed the action. Unconfirmed requests are inert.

Implementations

impl LifecycleRequest

pub fn new( series_id: SeriesId, action: LifecycleAction, actor: impl Into<String>, ) -> Self

A request that is not yet confirmed.

pub fn about(self, key: OccurrenceKey) -> Self

Name the occurrence the action is about.

pub fn because(self, reason: impl Into<String>) -> Self

Record why.

pub fn confirm(self) -> Self

Record the confirmation.

Trait Implementations

impl Clone for LifecycleRequest

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 LifecycleRequest

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

Formats the value using the given formatter.

impl Eq for LifecycleRequest

impl PartialEq for LifecycleRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LifecycleRequest