Struct KtFile

Source

pub struct KtFile {
    pub package: String,
    pub decls: Vec<KtDecl>,
    pub extra_imports: Vec<String>,
    pub banner: Option<String>,
}

Expand description

One Kotlin source file fragment: a package plus top-level declarations. Fragments of the same package are merged by super::file::merge_files.

Fields§

§package: String§decls: Vec<KtDecl>§extra_imports: Vec<String>

FQNs referenced only inside raw text the model can’t see (e.g. body strings built with pre-shortened type names). Registered into the file’s import set before any declaration renders.

§banner: Option<String>

Override the banner line prepended to the rendered file. None uses the default banner constant from the renderer. Some("") suppresses it.

Implementations§

Source §

impl KtFile

Source

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

Every problem in this file, with each check at its default severity (error).

An empty result means the file is as good as the model can prove: names, redeclarations and declaration shapes are checked, and Check enumerates exactly which. Anything needing type resolution, or reading the raw text inside KtCode bodies, stays the Kotlin compiler’s job.

Examples found in repository ?

examples/invalid.rs (line 26)

23fn main() {
24    println!("=== diagnostics (default: every check is an error) ===");
25    for file in broken_files() {
26        for d in file.validate() {
27            println!("{d}");
28        }
29    }
30
31    println!("\n=== merging refuses to produce anything ===");
32    match merge_files(broken_files()) {
33        Ok(_) => println!("unexpectedly merged"),
34        // The Display of the error is what a build script would surface.
35        Err(e) => print!("{e}"),
36    }
37
38    println!("\n=== the same model under `warn_all()` ===");
39    let (files, warnings) = merge_files_warning();
40    println!(
41        "merged {} file(s) with {} warning(s); generation continues",
42        files.len(),
43        warnings.len()
44    );
45
46    println!("\n=== one check downgraded, another switched off ===");
47    let policy = ValidationPolicy::new()
48        .warn(Check::DuplicateFunction)
49        .allow(Check::InvalidIdentifier);
50    for file in broken_files() {
51        for d in file.validate_with(&policy) {
52            println!("{d}");
53        }
54    }
55
56    println!("\n=== shapes the model will not build at all ===");
57    for (what, outcome) in refused_shapes() {
58        println!("{what}\n    -> {outcome}");
59    }
60}

Source

pub fn validate_with(&self, policy: &ValidationPolicy) -> Vec<Diagnostic>

KtFile::validate with per-check severities.

Examples found in repository ?

examples/invalid.rs (line 51)

23fn main() {
24    println!("=== diagnostics (default: every check is an error) ===");
25    for file in broken_files() {
26        for d in file.validate() {
27            println!("{d}");
28        }
29    }
30
31    println!("\n=== merging refuses to produce anything ===");
32    match merge_files(broken_files()) {
33        Ok(_) => println!("unexpectedly merged"),
34        // The Display of the error is what a build script would surface.
35        Err(e) => print!("{e}"),
36    }
37
38    println!("\n=== the same model under `warn_all()` ===");
39    let (files, warnings) = merge_files_warning();
40    println!(
41        "merged {} file(s) with {} warning(s); generation continues",
42        files.len(),
43        warnings.len()
44    );
45
46    println!("\n=== one check downgraded, another switched off ===");
47    let policy = ValidationPolicy::new()
48        .warn(Check::DuplicateFunction)
49        .allow(Check::InvalidIdentifier);
50    for file in broken_files() {
51        for d in file.validate_with(&policy) {
52            println!("{d}");
53        }
54    }
55
56    println!("\n=== shapes the model will not build at all ===");
57    for (what, outcome) in refused_shapes() {
58        println!("{what}\n    -> {outcome}");
59    }
60}