Struct CheckInfo 

pub struct CheckInfo {
    pub errors: Vec<String>,
    pub warnings: Vec<String>,
    pub deps: Vec<PathBuf>,
    pub lints: Vec<String>,
    pub requires: Vec<RequireSite>,
    pub error_fixes: Vec<Option<Fix>>,
    pub lint_fixes: Vec<Option<Fix>>,
    pub dependency_errors: Vec<DependencyError>,
}

Result of type-checking one .tl file.

Fields

errors: Vec<String>

file:line:col: message for syntax and type errors.

warnings: Vec<String>

file:line:col: message for warnings (non-fatal).

deps: Vec<PathBuf>

Files pulled in via require during checking (.tl / .d.tl / .lua).

lints: Vec<String>

htl lint findings (nil-index, enum-exhaustive). Advisory unless the caller promotes them (htl check --strict, include_tl!).

requires: Vec<RequireSite>

Every require("<literal>") in the file and where the checker resolved it. Input to require_cycles.

error_fixes: Vec<Option<Fix>>

error_fixes[i] is the fix for errors[i], when the error has one.

lint_fixes: Vec<Option<Fix>>

lint_fixes[i] is the fix for lints[i], when the lint has one.

dependency_errors: Vec<DependencyError>

Type errors in the modules this check pulled in through require, transitively, each dependency once. Not in errors, and not what ok answers: the file itself checked, and generates; it is the require of that module that will raise at run time (Htl::install_searcher), which is why a caller reporting on a project treats these as errors too (htl check, include_tl!).

Implementations

impl CheckInfo

pub fn ok(&self) -> bool

true when nothing failed the check — errors only. Warnings and lints are the caller’s to promote (clean is the stricter question), so this is what decides whether generated code may be run.

pub fn clean(&self) -> bool

true when there are no errors, warnings or lints.

pub fn diagnostics(&self) -> Vec<Diagnostic>

Everything this check found about the file itself, structured, in the order the text output says it: warnings, then lints, then errors.

Errors in what the file required are not here — they belong to the module they are in, and it is the reporting caller that decides how to say them (dependency_errors).

pub fn error_diagnostics(&self) -> Vec<Diagnostic>

errors with their positions and their fixes.

pub fn warning_diagnostics(&self) -> Vec<Diagnostic>

warnings with their positions. Warnings carry no fix.

pub fn lint_diagnostics(&self) -> Vec<Diagnostic>

lints with their positions, their rule names and their fixes.

Trait Implementations

impl Clone for CheckInfo

fn clone(&self) -> CheckInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckInfo

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

Formats the value using the given formatter.

impl Default for CheckInfo

fn default() -> CheckInfo

Returns the “default value” for a type.