Enum GenerationOutcome 

pub enum GenerationOutcome {
    Created {
        series_id: SeriesId,
        key: OccurrenceKey,
        date: DateKey,
        issue_number: u32,
        filename: String,
    },
    NoOp {
        series_id: SeriesId,
        key: OccurrenceKey,
        state: KeyState,
        message: String,
    },
    Rejected {
        diagnostics: Vec<GenerationDiagnostic>,
    },
}

The result of one confirmed generation attempt (data-model.md §8, T021).

Exactly one of three shapes, and each is a result, not an error: a surface reports one outcome per candidate, so a refusal is data the caller shows rather than an exception it has to catch.

Variants

Created

The occurrence was created, linked and recorded.

Fields

series_id: SeriesId

The series it belongs to.

key: OccurrenceKey

Its occurrence key.

date: DateKey

The date it was generated for.

issue_number: u32

The new issue’s number.

filename: String

The new issue’s filename.

NoOp

The key was already taken: an occurrence exists, or the series skipped it. Nothing was written.

Fields

series_id: SeriesId

The series.

key: OccurrenceKey

The key that was already taken.

state: KeyState

Which of the two it was.

message: String

One sentence saying which.

Rejected

The action was refused. Nothing was written.

Fields

diagnostics: Vec<GenerationDiagnostic>

Every reason, in the order they were found.

Implementations

impl GenerationOutcome

pub fn is_created(&self) -> bool

Whether an occurrence was created.

pub fn is_noop(&self) -> bool

Whether the key was already taken.

pub fn is_rejected(&self) -> bool

Whether the action was refused.

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

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

pub fn render(&self) -> String

One line for a surface: what happened, and to what.

Trait Implementations

impl Clone for GenerationOutcome

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 GenerationOutcome

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

Formats the value using the given formatter.

impl Eq for GenerationOutcome

impl PartialEq for GenerationOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GenerationOutcome