Struct ConvergenceReport 

pub struct ConvergenceReport {
    pub schema: String,
    pub repository: String,
    pub trunk: Option<String>,
    pub holdings: Vec<Holding>,
    pub tallies: BTreeMap<String, usize>,
    pub at_risk: usize,
    pub converged: bool,
}

The repository’s convergence: every holding, and the one verdict over them.

use majordomus_cli::convergence::{ConvergenceReport, SCHEMA};

let empty = ConvergenceReport {
    schema: SCHEMA.into(),
    repository: "/tmp/r".into(),
    trunk: Some("master".into()),
    holdings: vec![],
    tallies: Default::default(),
    at_risk: 0,
    converged: true,
};
// the verdict is the one word a gate reads; the count is what a person reads next to it
assert!(empty.converged && empty.at_risk == 0);
assert_eq!(serde_json::to_value(&empty).unwrap()["schema"], "convergence/v1");

Fields

schema: String

SCHEMA.

repository: String

The primary checkout this was measured from.

trunk: Option<String>

The trunk the containment was decided against, when there is one.

holdings: Vec<Holding>

Every holding, at-risk ones first, then by kind and identity.

tallies: BTreeMap<String, usize>

How many holdings carry each disposition, by its word.

at_risk: usize

The holdings that exist on one disk only.

converged: bool

Nothing is held where it can be lost.

Implementations

impl ConvergenceReport

pub fn summary(&self) -> String

The one line a person or a gate reads first, stating the count it refuses over.

use majordomus_cli::convergence::{ConvergenceReport, SCHEMA};

let mut report = ConvergenceReport {
    schema: SCHEMA.into(),
    repository: "/tmp/r".into(),
    trunk: None,
    holdings: vec![],
    tallies: Default::default(),
    at_risk: 0,
    converged: true,
};
assert!(report.summary().starts_with("converged"));
report.at_risk = 2;
report.converged = false;
assert!(report.summary().starts_with("not converged: 2 of"));

Trait Implementations

impl Clone for ConvergenceReport

fn clone(&self) -> ConvergenceReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConvergenceReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConvergenceReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConvergenceReport

impl JsonSchema for ConvergenceReport

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ConvergenceReport

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ConvergenceReport

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 ConvergenceReport