Struct Retirement 

pub struct Retirement {
    pub class: RetirementClass,
    pub reason: Option<KeepReason>,
    pub cause: Option<UnknownCause>,
    pub identity: String,
    pub branch: String,
    pub tip: Sha,
    pub base: String,
    pub proof: Option<RetirementProof>,
    pub content_free_commits: Vec<Sha>,
    pub superseded_by: Option<SupersededBy>,
    pub differing_paths: Vec<String>,
    pub holders: Vec<BranchHolder>,
}

What a branch is, and everything that says so.

Fields

class: RetirementClass

Which class it is.

reason: Option<KeepReason>

Why it is kept, for RetirementClass::Keep alone.

cause: Option<UnknownCause>

The read that failed, for KeepReason::Unknown alone. A document written before this field existed reads as None.

identity: String

The identity it belongs to.

branch: String

The branch.

tip: Sha

Where it stands: the first copy’s tip, in search order.

base: String

The base it is judged against.

proof: Option<RetirementProof>

What proves it holds nothing beyond the base, for RetirementClass::Retirable alone.

content_free_commits: Vec<Sha>

The commits at its tip that change no content, which no proof asks about.

superseded_by: Option<SupersededBy>

The retry that superseded it, for RetirementClass::SupersededWithChanges.

differing_paths: Vec<String>

The paths it changed that differ from the base: non-empty exactly for superseded-with-changes and for keep with unmerged-unique-commits.

holders: Vec<BranchHolder>

Every place holding a copy of it, in search order.

Implementations

impl Retirement

pub fn cause(&self) -> Option<&UnknownCause>

The read that failed, for a branch kept as KeepReason::Unknown.

pub fn evidence(&self) -> Vec<String>

The evidence a refusal prints beside the class: the proof, what superseded it, the paths that differ, and where it is.

pub fn verdict(&self) -> String

class and, for a kept branch, / reason — and, for one kept as unknown, : and the read that failed — as a line says them.

Trait Implementations

impl Clone for Retirement

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 Retirement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Retirement

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Retirement

impl PartialEq for Retirement

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Retirement

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Retirement