Struct SyntaxReport 

pub struct SyntaxReport {
    pub root: String,
    pub scope: &'static str,
    pub checked: usize,
    pub skipped: usize,
    pub languages: Vec<String>,
    pub findings: Vec<SyntaxFinding>,
}

The result of syntax-checking a bundle’s code blocks.

checked and skipped are both reported, deliberately. A language with no backend compiled in is not checked rather than clean, and a report that conflated the two would be a check that passes by not looking.

Fields

root: String

The bundle root, as the caller named it.

scope: &'static str

computations or all-blocks — what was looked at.

checked: usize

Blocks a backend actually parsed.

skipped: usize

Blocks left alone, for any of three reasons: the block carried no language tag, this build has no backend for the language it carried, or the computation named a file rather than inlining its code.

All three are “not looked at” rather than “looked at and clean”, which is the distinction the whole report exists to keep.

languages: Vec<String>

The languages this build can check, so a reader can tell why.

findings: Vec<SyntaxFinding>

Findings, in bundle order.

Implementations

impl SyntaxReport

pub const fn passed(&self) -> bool

true when nothing failed to parse.

Trait Implementations

impl Clone for SyntaxReport

fn clone(&self) -> SyntaxReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxReport

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

Formats the value using the given formatter.

impl Serialize for SyntaxReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.