Struct Report 

pub struct Report {
    pub changes: BTreeMap<String, Change>,
    pub unchanged: BTreeMap<String, Vec<String>>,
    pub archived: bool,
    pub admin: Option<bool>,
    pub governance: Option<Shadowing>,
    pub limitations: Vec<Limitation>,
    pub lockouts: Vec<Lockout>,
}

The plan result used by both text and machine reports.

Fields

changes: BTreeMap<String, Change>

Fields that would change, grouped by resource name.

unchanged: BTreeMap<String, Vec<String>>

Fields that already match, grouped by resource name.

archived: bool

A plan can be inspected but not applied when archived.

admin: Option<bool>

Whether the caller administers the repository, when the forge says.

governance: Option<Shadowing>

Which rule governs the default branch, on forges where rule order decides.

limitations: Vec<Limitation>

Access or settings that the forge exposes but this tool cannot change.

lockouts: Vec<Lockout>

Grants carrying the caller’s own access that the plan would remove.

Implementations

impl Report

pub fn refusal(&self, repository: &RepoRef) -> Option<Refusal>

The first reason the plan cannot be applied to repository, if any.

pub fn lines(&self) -> impl Iterator<Item = String> + '_

The report lines for every change, one per changed field.

impl Report

pub fn record_delete(&mut self, resource: String)

Note that resource would be deleted.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Report

Returns the “default value” for a type.