Struct BatchPlan 

pub struct BatchPlan {
    pub selection: Selection,
    pub patch: IssuePatch,
    pub items: Vec<ItemPlan>,
    pub pair: Option<PairPlan>,
    pub archive: Option<ArchiveRequest>,
    pub confirmation: Option<Confirmation>,
}

A read-only preview. Cancelling one changes nothing, by construction.

Fields

selection: Selection

The exact selection this plan was built from, so an apply can check that the thing it was authorized for is the thing in front of it.

patch: IssuePatch

items: Vec<ItemPlan>

pair: Option<PairPlan>

The relationship change this plan proposes, if the patch named a pair.

archive: Option<ArchiveRequest>

The archive request this plan carries, unapplied.

confirmation: Option<Confirmation>

The confirmation, absent until one is issued. None is the ordinary state; see Confirmation.

Implementations

impl BatchPlan

pub fn actionable(&self) -> impl Iterator<Item = &ItemPlan>

The items that would be written.

pub fn blocked(&self) -> impl Iterator<Item = &ItemPlan>

The items that cannot be applied.

pub fn is_empty(&self) -> bool

Whether applying this plan would change anything.

pub fn summary(&self) -> String

The one-line summary the CLI prints above the table.

pub fn confirmation_is_valid(&self) -> bool

Whether a confirmation on this plan is still valid.

A confirmation authorizes a specific plan. If either the selection or the patch has changed, it is a different plan and the old confirmation does not carry over (contract §4: “any change to selection or patch requires a new preview”).

Trait Implementations

impl Clone for BatchPlan

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 BatchPlan

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

Formats the value using the given formatter.

impl Eq for BatchPlan

impl PartialEq for BatchPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BatchPlan