Enum DeliveryFailure 

pub enum DeliveryFailure {
    Preflight {
        reason: String,
    },
    Commit {
        reason: String,
    },
    Push {
        reason: String,
        retriable: bool,
    },
    Pr {
        reason: String,
        retriable: bool,
    },
}

Why a PR delivery stopped, at which stage, and whether the next round should simply try again.

The stage is not decoration: it is the difference between “the work is safe on disk, re-push it” and “this goal cannot progress without a human”. It maps 1:1 onto the delivery_failed event’s stage field.

Variants

Preflight

Refused before touching anything — a missing GitHub credential, a branch name git/gh would misread, a target branch equal to the base, or either half of the delivery-head policy (delivery_head_refusal): an ambiguous head, where the target branch already carries an open pull request into some other base that the push would silently add this round’s commits to (ambiguous_head_refusal); or a closed pull request into this run’s own base, which is somebody’s decision that this branch should stop (closed_pr_refusal). Never retriable: nothing about running again changes any of them. Those two are the causes here that depend on remote STATE rather than on the invocation, so they are also the ones a stage: "preflight" reader is most likely to misread as a configuration mistake — clearing either means acting on the other pull request (closing the ambiguous one, reopening the closed one) or picking a different --target-branch.

Fields

reason: String

Commit

The worktree could not be committed. Not retriable — the same worktree will fail the same way.

Fields

reason: String

Push

The push was refused. retriable is true for the ordinary case (the branch moved, so the next round re-cuts from its head and replays) and false for credential/permission refusals.

Fields

reason: String

retriable: bool

Pr

A gh pull-request call failed. Usually retriable (a GitHub API blip); the work is not lost either way. Reached from two places, and the state of the remote differs between them: reconciliation runs after the push, so the commit is safely on the branch, while the head-ambiguity listing in preflight runs before it, so nothing has been committed or pushed at all. Both are the same verdict — retry the delivery — which is why they share a variant.

Fields

reason: String

retriable: bool

Implementations

impl DeliveryFailure

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

The wire spelling of the stage — preflight | commit | push | pr.

pub fn retriable(&self) -> bool

Whether the next round should just try the same delivery again. Preflight and commit failures are definitionally not retriable.

pub fn reason(&self) -> &str

The human-readable reason, without the stage prefix.

Trait Implementations

impl Clone for DeliveryFailure

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 DeliveryFailure

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

Formats the value using the given formatter.

impl Display for DeliveryFailure

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

Formats the value using the given formatter.

impl Error for DeliveryFailure

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for DeliveryFailure

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DeliveryFailure