Struct ValidationIssue 

pub struct ValidationIssue { /* private fields */ }

A single validation issue found in a template.

Each issue contains information about the problem, its severity, and optionally the location where it was found.

Implementations

impl ValidationIssue

pub fn new<S: Into<String>>( severity: Severity, category: IssueCategory, message: S, ) -> Self

Create a new validation issue.

Examples

use tron::validation::{ValidationIssue, Severity, IssueCategory};

let issue = ValidationIssue::new(
    Severity::Warning,
    IssueCategory::Style,
    "Consider using descriptive placeholder names"
);

pub fn with_line(self, line: usize) -> Self

Set the line number where the issue was found.

Examples

use tron::validation::{ValidationIssue, Severity, IssueCategory};

let issue = ValidationIssue::new(Severity::Error, IssueCategory::Syntax, "Invalid syntax")
    .with_line(5);

pub fn with_column(self, column: usize) -> Self

Set the column number where the issue was found.

pub fn with_suggestion<S: Into<String>>(self, suggestion: S) -> Self

Add a suggestion for fixing the issue.

Examples

use tron::validation::{ValidationIssue, Severity, IssueCategory};

let issue = ValidationIssue::new(Severity::Warning, IssueCategory::Style, "Short placeholder name")
    .with_suggestion("Consider using a more descriptive name like 'function_name'");

pub fn severity(&self) -> Severity

Get the issue severity.

Examples found in repository

examples/validation_usage.rs (line 153)

fn example_multiple_template_validation() -> Result<()> {
    println!("5. Multiple Template Validation:");
    
    let templates = vec![
        TronTemplate::new("fn @[function_name]@(@[params]@) -> @[return_type]@ { @[body]@ }")?,
        TronTemplate::new("struct @[n]@ { @[f]@ }")?,  // Short placeholder names
        TronTemplate::new("Hello @[user_name]@! Welcome to @[application_name]@.")?,  // Good template
        TronTemplate::new("const @[C]@ = @[value]@;")?,  // Uppercase in placeholder
    ];
    
    let validator = TemplateValidator::new();
    
    // Validate each template and collect results
    for (index, template) in templates.iter().enumerate() {
        let report = validator.validate(template)?;
        
        println!("   Template #{}: {} issue(s)", 
            index + 1, 
            report.issues().len()
        );
        
        if report.has_issues() {
            // Show first few issues
            for issue in report.issues().iter().take(2) {
                println!("     - [{}] {}: {}", 
                    issue.severity(), 
                    issue.category(),
                    issue.message()
                );
            }
            if report.issues().len() > 2 {
                println!("     ... and {} more", report.issues().len() - 2);
            }
        } else {
            println!("     ✓ No issues found");
        }
        println!();
    }
    
    // Demonstrate template reference validation
    println!("   Template Reference Validation:");
    let template = TronTemplate::new("fn main() { @[body]@ }")?;
    let template_ref = TronRef::new(template)
        .with_dependency("unsafe_crate = \"0.1\"");
    
    let report = validator.validate_ref(&template_ref)?;
    println!("   TronRef validation: {} issue(s)", report.issues().len());
    
    Ok(())
}

pub fn category(&self) -> &IssueCategory

Get the issue category.

Examples found in repository

examples/validation_usage.rs (line 154)

fn example_multiple_template_validation() -> Result<()> {
    println!("5. Multiple Template Validation:");
    
    let templates = vec![
        TronTemplate::new("fn @[function_name]@(@[params]@) -> @[return_type]@ { @[body]@ }")?,
        TronTemplate::new("struct @[n]@ { @[f]@ }")?,  // Short placeholder names
        TronTemplate::new("Hello @[user_name]@! Welcome to @[application_name]@.")?,  // Good template
        TronTemplate::new("const @[C]@ = @[value]@;")?,  // Uppercase in placeholder
    ];
    
    let validator = TemplateValidator::new();
    
    // Validate each template and collect results
    for (index, template) in templates.iter().enumerate() {
        let report = validator.validate(template)?;
        
        println!("   Template #{}: {} issue(s)", 
            index + 1, 
            report.issues().len()
        );
        
        if report.has_issues() {
            // Show first few issues
            for issue in report.issues().iter().take(2) {
                println!("     - [{}] {}: {}", 
                    issue.severity(), 
                    issue.category(),
                    issue.message()
                );
            }
            if report.issues().len() > 2 {
                println!("     ... and {} more", report.issues().len() - 2);
            }
        } else {
            println!("     ✓ No issues found");
        }
        println!();
    }
    
    // Demonstrate template reference validation
    println!("   Template Reference Validation:");
    let template = TronTemplate::new("fn main() { @[body]@ }")?;
    let template_ref = TronRef::new(template)
        .with_dependency("unsafe_crate = \"0.1\"");
    
    let report = validator.validate_ref(&template_ref)?;
    println!("   TronRef validation: {} issue(s)", report.issues().len());
    
    Ok(())
}

pub fn message(&self) -> &str

Get the issue message.

Examples found in repository

examples/validation_usage.rs (line 118)

fn example_security_validation() -> Result<()> {
    println!("4. Security Validation:");
    
    // Template with potential security issues
    let template = TronTemplate::new(
        r#"
function processData() {
    eval(@[user_code]@);
    var password = "@[user_password]@";
    return "<script>alert('XSS');</script>";
}
"#
    )?;
    
    let validator = TemplateValidator::new();
    let report = validator.validate(&template)?;
    
    println!("   Template with security concerns:");
    println!("   {}", report);
    
    // Show only security issues
    let security_issues = report.issues_by_category(&IssueCategory::Security);
    if !security_issues.is_empty() {
        println!("   Security-specific issues:");
        for (i, issue) in security_issues.iter().enumerate() {
            println!("     {}. {}", i + 1, issue.message());
            if let Some(suggestion) = issue.suggestion() {
                println!("        Suggestion: {}", suggestion);
            }
        }
    }
    
    Ok(())
}

fn example_multiple_template_validation() -> Result<()> {
    println!("5. Multiple Template Validation:");
    
    let templates = vec![
        TronTemplate::new("fn @[function_name]@(@[params]@) -> @[return_type]@ { @[body]@ }")?,
        TronTemplate::new("struct @[n]@ { @[f]@ }")?,  // Short placeholder names
        TronTemplate::new("Hello @[user_name]@! Welcome to @[application_name]@.")?,  // Good template
        TronTemplate::new("const @[C]@ = @[value]@;")?,  // Uppercase in placeholder
    ];
    
    let validator = TemplateValidator::new();
    
    // Validate each template and collect results
    for (index, template) in templates.iter().enumerate() {
        let report = validator.validate(template)?;
        
        println!("   Template #{}: {} issue(s)", 
            index + 1, 
            report.issues().len()
        );
        
        if report.has_issues() {
            // Show first few issues
            for issue in report.issues().iter().take(2) {
                println!("     - [{}] {}: {}", 
                    issue.severity(), 
                    issue.category(),
                    issue.message()
                );
            }
            if report.issues().len() > 2 {
                println!("     ... and {} more", report.issues().len() - 2);
            }
        } else {
            println!("     ✓ No issues found");
        }
        println!();
    }
    
    // Demonstrate template reference validation
    println!("   Template Reference Validation:");
    let template = TronTemplate::new("fn main() { @[body]@ }")?;
    let template_ref = TronRef::new(template)
        .with_dependency("unsafe_crate = \"0.1\"");
    
    let report = validator.validate_ref(&template_ref)?;
    println!("   TronRef validation: {} issue(s)", report.issues().len());
    
    Ok(())
}

pub fn line(&self) -> Option<usize>

Get the line number if available.

pub fn column(&self) -> Option<usize>

Get the column number if available.

pub fn suggestion(&self) -> Option<&str>

Get the suggestion if available.

Examples found in repository

examples/validation_usage.rs (line 119)

fn example_security_validation() -> Result<()> {
    println!("4. Security Validation:");
    
    // Template with potential security issues
    let template = TronTemplate::new(
        r#"
function processData() {
    eval(@[user_code]@);
    var password = "@[user_password]@";
    return "<script>alert('XSS');</script>";
}
"#
    )?;
    
    let validator = TemplateValidator::new();
    let report = validator.validate(&template)?;
    
    println!("   Template with security concerns:");
    println!("   {}", report);
    
    // Show only security issues
    let security_issues = report.issues_by_category(&IssueCategory::Security);
    if !security_issues.is_empty() {
        println!("   Security-specific issues:");
        for (i, issue) in security_issues.iter().enumerate() {
            println!("     {}. {}", i + 1, issue.message());
            if let Some(suggestion) = issue.suggestion() {
                println!("        Suggestion: {}", suggestion);
            }
        }
    }
    
    Ok(())
}

Trait Implementations

impl Clone for ValidationIssue

fn clone(&self) -> ValidationIssue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationIssue

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

Formats the value using the given formatter.

impl Display for ValidationIssue

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

Formats the value using the given formatter.