Struct ValidationPolicy 

pub struct ValidationPolicy { /* private fields */ }

Per-check severity, so a consumer can downgrade or disable a check instead of pinning an old version of this crate when one misfires.

Every check is an error by default.

use kotlin_codegen::{Check, Severity, ValidationPolicy};
let policy = ValidationPolicy::new().warn(Check::DuplicateType);
assert_eq!(
    policy.severity_of(Check::DuplicateType),
    Some(Severity::Warning)
);

Implementations

impl ValidationPolicy

pub fn new() -> Self

Every check an error.

Examples found in repository

examples/invalid.rs (line 47)

fn main() {
    println!("=== diagnostics (default: every check is an error) ===");
    for file in broken_files() {
        for d in file.validate() {
            println!("{d}");
        }
    }

    println!("\n=== merging refuses to produce anything ===");
    match merge_files(broken_files()) {
        Ok(_) => println!("unexpectedly merged"),
        // The Display of the error is what a build script would surface.
        Err(e) => print!("{e}"),
    }

    println!("\n=== the same model under `warn_all()` ===");
    let (files, warnings) = merge_files_warning();
    println!(
        "merged {} file(s) with {} warning(s); generation continues",
        files.len(),
        warnings.len()
    );

    println!("\n=== one check downgraded, another switched off ===");
    let policy = ValidationPolicy::new()
        .warn(Check::DuplicateFunction)
        .allow(Check::InvalidIdentifier);
    for file in broken_files() {
        for d in file.validate_with(&policy) {
            println!("{d}");
        }
    }

    println!("\n=== shapes the model will not build at all ===");
    for (what, outcome) in refused_shapes() {
        println!("{what}\n    -> {outcome}");
    }
}

pub fn warn(self, check: Check) -> Self

Report check but keep generating.

Examples found in repository

examples/invalid.rs (line 48)

fn main() {
    println!("=== diagnostics (default: every check is an error) ===");
    for file in broken_files() {
        for d in file.validate() {
            println!("{d}");
        }
    }

    println!("\n=== merging refuses to produce anything ===");
    match merge_files(broken_files()) {
        Ok(_) => println!("unexpectedly merged"),
        // The Display of the error is what a build script would surface.
        Err(e) => print!("{e}"),
    }

    println!("\n=== the same model under `warn_all()` ===");
    let (files, warnings) = merge_files_warning();
    println!(
        "merged {} file(s) with {} warning(s); generation continues",
        files.len(),
        warnings.len()
    );

    println!("\n=== one check downgraded, another switched off ===");
    let policy = ValidationPolicy::new()
        .warn(Check::DuplicateFunction)
        .allow(Check::InvalidIdentifier);
    for file in broken_files() {
        for d in file.validate_with(&policy) {
            println!("{d}");
        }
    }

    println!("\n=== shapes the model will not build at all ===");
    for (what, outcome) in refused_shapes() {
        println!("{what}\n    -> {outcome}");
    }
}

pub fn deny(self, check: Check) -> Self

Stop generating on check (the default).

pub fn warn_all() -> Self

Downgrade every check to a warning.

The way to adopt validation in a generator that already produces output: run it in warning mode first, look at what comes back, and switch to the default once it is quiet. Reaching a clean run and then dropping this call is much less disruptive than having a build start failing on output that was fine yesterday.

use kotlin_codegen::{Check, Severity, ValidationPolicy};
let policy = ValidationPolicy::warn_all();
for check in Check::ALL {
    assert_eq!(policy.severity_of(*check), Some(Severity::Warning));
}

Examples found in repository

examples/invalid.rs (line 176)

fn merge_files_warning() -> (Vec<KtFile>, Vec<kotlin_codegen::Diagnostic>) {
    kotlin_codegen::merge_files_with(broken_files(), &ValidationPolicy::warn_all())
        .expect("warnings never stop generation")
}

pub fn allow(self, check: Check) -> Self

Turn check off entirely.

Examples found in repository

examples/invalid.rs (line 49)

fn main() {
    println!("=== diagnostics (default: every check is an error) ===");
    for file in broken_files() {
        for d in file.validate() {
            println!("{d}");
        }
    }

    println!("\n=== merging refuses to produce anything ===");
    match merge_files(broken_files()) {
        Ok(_) => println!("unexpectedly merged"),
        // The Display of the error is what a build script would surface.
        Err(e) => print!("{e}"),
    }

    println!("\n=== the same model under `warn_all()` ===");
    let (files, warnings) = merge_files_warning();
    println!(
        "merged {} file(s) with {} warning(s); generation continues",
        files.len(),
        warnings.len()
    );

    println!("\n=== one check downgraded, another switched off ===");
    let policy = ValidationPolicy::new()
        .warn(Check::DuplicateFunction)
        .allow(Check::InvalidIdentifier);
    for file in broken_files() {
        for d in file.validate_with(&policy) {
            println!("{d}");
        }
    }

    println!("\n=== shapes the model will not build at all ===");
    for (what, outcome) in refused_shapes() {
        println!("{what}\n    -> {outcome}");
    }
}

pub fn severity_of(&self, check: Check) -> Option<Severity>

The effective severity of check, or None when it is off.

Trait Implementations

impl Clone for ValidationPolicy

fn clone(&self) -> ValidationPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationPolicy

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

Formats the value using the given formatter.

impl Default for ValidationPolicy

fn default() -> ValidationPolicy

Returns the “default value” for a type.