Struct LayoutReport 

pub struct LayoutReport {
    pub measured: bool,
    pub reason: Option<String>,
    pub checked: usize,
    pub findings: Vec<LayoutFinding>,
    pub passes: bool,
}

The answer of the layout check: whether the halves were read, how many paths were judged, and every path a contract excludes. A report that could not read the halves never passes, so silence about a tree nobody measured cannot read as a clean tree.

use majordomus_cli::layout::LayoutReport;
let clean = LayoutReport::of(true, None, 12, Vec::new());
assert!(clean.passes);
assert_eq!(clean.checked, 12);
let unread = LayoutReport::of(false, Some("git could not start".into()), 0, Vec::new());
assert!(!unread.passes, "nothing found because nothing was read");
assert_eq!(unread.reason.as_deref(), Some("git could not start"));

Fields

measured: bool

Whether the halves could be read at all. false is not a pass.

reason: Option<String>

Why they could not, when they could not.

checked: usize

How many paths were judged.

findings: Vec<LayoutFinding>

Every path a contract excludes, in canonical order. Empty is the passing answer.

passes: bool

true when the halves were read and nothing was found.

Implementations

impl LayoutReport

pub fn of( measured: bool, reason: Option<String>, checked: usize, findings: Vec<LayoutFinding>, ) -> Self

A report, its verdict derived from what was measured and found. The findings are put in canonical order — by path, the contract breaking the tie — whatever order the walk found them in, so two runs over one tree answer the same bytes.

use majordomus_cli::layout::{LayoutFinding, LayoutReport};
let at = |path: &str| LayoutFinding {
    path: path.into(),
    contract: "manifest local".into(),
    excludes: "canonical".into(),
    reason: "a copy".into(),
};
let found = vec![at(".ai/local/z.md"), at(".ai/local/a.md")];
let report = LayoutReport::of(true, None, 5, found);
assert!(!report.passes, "measured, but something was found");
let paths: Vec<&str> = report.findings.iter().map(|f| f.path.as_str()).collect();
assert_eq!(paths, [".ai/local/a.md", ".ai/local/z.md"]);

Trait Implementations

impl Clone for LayoutReport

fn clone(&self) -> LayoutReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LayoutReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LayoutReport

impl JsonSchema for LayoutReport

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 LayoutReport

fn eq(&self, other: &LayoutReport) -> 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 LayoutReport

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 LayoutReport