Struct DiagnosticMessageBuilder 

pub struct DiagnosticMessageBuilder { /* private fields */ }

Builder for creating diagnostic messages following tidyverse guidelines.

The builder API naturally encourages the tidyverse four-part error structure:

1. Title: Brief error message (via .error(), .warning(), etc.)
2. Problem: What went wrong - the “must” or “can’t” statement (via .problem())
3. Details: Specific information - max 5 bulleted items (via .add_detail(), .add_info())
4. Hints: Optional guidance (via .add_hint())

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Incompatible types")
    .with_code("Q-1-2") // quarto-error-code-audit-ignore
    .problem("Cannot combine date and datetime types")
    .add_detail("`x`{.arg} has type `date`{.type}")
    .add_detail("`y`{.arg} has type `datetime`{.type}")
    .add_hint("Convert both to the same type?")
    .build();

assert_eq!(error.title, "Incompatible types");
assert_eq!(error.code, Some("Q-1-2".to_string())); // quarto-error-code-audit-ignore
assert!(error.problem.is_some());
assert_eq!(error.details.len(), 2);
assert_eq!(error.hints.len(), 1);

Implementations

impl DiagnosticMessageBuilder

pub fn new(kind: DiagnosticKind, title: impl Into<String>) -> Self

Create a new builder with the specified kind and title.

Most code should use the convenience methods .error(), .warning(), or .info() instead of calling this directly.

pub fn error(title: impl Into<String>) -> Self

Create an error diagnostic builder.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("YAML Syntax Error")
    .build();

Examples found in repository

examples/diagnostic_collector.rs (line 39)

    fn error_at(&mut self, message: impl Into<String>, location: SourceInfo) {
        self.add(
            DiagnosticMessageBuilder::error(message.into())
                .with_location(location)
                .build(),
        );
    }

examples/renderer_selection.rs (line 27)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/builder_api.rs (line 11)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

examples/with_location.rs (line 22)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 20)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn generic_error( message: impl Into<String>, file: &str, line: u32, ) -> DiagnosticMessage

Create a generic error for migration purposes.

This is a convenience method for the migration from ErrorCollector to DiagnosticMessage. It creates an error with code Q-0-99 (quarto-error-code-audit-ignore) and includes file/line information for tracking where the error originated in the code.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::generic_error(
    "Found unexpected attribute",
    file!(),
    line!()
);
assert_eq!(error.code, Some("Q-0-99".to_string())); // quarto-error-code-audit-ignore
assert!(error.title.contains("Found unexpected attribute"));

pub fn generic_warning( message: impl Into<String>, file: &str, line: u32, ) -> DiagnosticMessage

Create a generic warning for migration purposes.

Similar to generic_error() but for warnings.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let warning = DiagnosticMessageBuilder::generic_warning(
    "Caption found without table",
    file!(),
    line!()
);
assert_eq!(warning.code, Some("Q-0-99".to_string()));

pub fn warning(title: impl Into<String>) -> Self

Create a warning diagnostic builder.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let warning = DiagnosticMessageBuilder::warning("Deprecated feature")
    .build();

Examples found in repository

examples/diagnostic_collector.rs (line 96)

fn main() {
    println!("=== Example 1: Accumulating multiple errors ===\n");

    let mut collector = SimpleCollector::new();

    // Simulate validating a YAML file
    collector.error("Missing required field 'title'");
    collector.warn("Field 'description' is deprecated");
    collector.error("Invalid value for 'format': expected string, got number");

    if collector.has_errors() {
        println!(
            "Validation failed with {} diagnostics:",
            collector.diagnostics().len()
        );
        for text in collector.to_text(None) {
            println!("{}", text);
        }
    }

    println!("\n=== Example 2: Errors with source locations ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "config.yml".to_string(),
        Some("title: 123\nformat: html\nauthor: John\n".to_string()),
    );

    let mut collector2 = SimpleCollector::new();

    // Error in "title: 123" (offsets 7-10)
    let loc1 = SourceInfo::original(file_id, 7, 10);
    collector2.error_at("Title must be a string", loc1);

    // Warning at "John" (offsets 33-37)
    let loc2 = SourceInfo::original(file_id, 33, 37);
    let warning = DiagnosticMessageBuilder::warning("Author field should include email")
        .with_location(loc2)
        .add_hint("Use format: 'Name <email@example.com>'")
        .build();
    collector2.add(warning);

    println!("Collected diagnostics:");
    for text in collector2.to_text(Some(&ctx)) {
        println!("{}", text);
        println!();
    }

    println!("=== Example 3: JSON output for all diagnostics ===\n");

    let json_array: Vec<_> = collector2
        .diagnostics()
        .iter()
        .map(|d| d.to_json())
        .collect();

    println!("{}", serde_json::to_string_pretty(&json_array).unwrap());

    println!("\n=== Example 4: Continuing vs. failing fast ===\n");

    let mut collector3 = SimpleCollector::new();

    // In some subsystems, we collect all errors before failing
    for i in 1..=3 {
        collector3.error(format!("Error in item {}", i));
    }

    // Check at the end
    if collector3.has_errors() {
        eprintln!(
            "Processing failed with {} errors",
            collector3.diagnostics().len()
        );
        eprintln!("\nErrors:");
        for diag in collector3.diagnostics() {
            eprintln!("  - {}", diag.title);
        }
    }
}

pub fn info(title: impl Into<String>) -> Self

Create an info diagnostic builder.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let info = DiagnosticMessageBuilder::info("Processing complete")
    .build();

pub fn with_code(self, code: impl Into<String>) -> Self

Set the error code.

Error codes follow the format Q-<subsystem>-<number> (e.g., “Q-1-1”). (quarto-error-code-audit-ignore)

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("YAML Syntax Error")
    .with_code("Q-1-1") // quarto-error-code-audit-ignore
    .build();

assert_eq!(error.code, Some("Q-1-1".to_string())); // quarto-error-code-audit-ignore

Examples found in repository

examples/renderer_selection.rs (line 28)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/with_location.rs (line 23)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 21)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn with_location(self, location: SourceInfo) -> Self

Attach a source location to this diagnostic.

The location identifies where in the source code the issue occurred. The location may track transformation history, allowing the error to be mapped back through multiple processing steps to the original source file.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;
use quarto_source_map::{SourceInfo, SourceContext, FileId, Range, Location};

let mut ctx = SourceContext::new();
let file_id = ctx.add_file("test.qmd".into(), Some("content".into()));
let range = Range {
    start: Location { offset: 0, row: 0, column: 0 },
    end: Location { offset: 7, row: 0, column: 7 },
};
let source_info = SourceInfo::original(file_id, range);

let error = DiagnosticMessageBuilder::error("Parse error")
    .with_location(source_info)
    .build();

Examples found in repository

examples/diagnostic_collector.rs (line 40)

    fn error_at(&mut self, message: impl Into<String>, location: SourceInfo) {
        self.add(
            DiagnosticMessageBuilder::error(message.into())
                .with_location(location)
                .build(),
        );
    }

    fn has_errors(&self) -> bool {
        self.diagnostics
            .iter()
            .any(|d| d.kind == DiagnosticKind::Error)
    }

    fn diagnostics(&self) -> &[DiagnosticMessage] {
        &self.diagnostics
    }

    fn to_text(&self, ctx: Option<&SourceContext>) -> Vec<String> {
        self.diagnostics.iter().map(|d| d.to_text(ctx)).collect()
    }
}

fn main() {
    println!("=== Example 1: Accumulating multiple errors ===\n");

    let mut collector = SimpleCollector::new();

    // Simulate validating a YAML file
    collector.error("Missing required field 'title'");
    collector.warn("Field 'description' is deprecated");
    collector.error("Invalid value for 'format': expected string, got number");

    if collector.has_errors() {
        println!(
            "Validation failed with {} diagnostics:",
            collector.diagnostics().len()
        );
        for text in collector.to_text(None) {
            println!("{}", text);
        }
    }

    println!("\n=== Example 2: Errors with source locations ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "config.yml".to_string(),
        Some("title: 123\nformat: html\nauthor: John\n".to_string()),
    );

    let mut collector2 = SimpleCollector::new();

    // Error in "title: 123" (offsets 7-10)
    let loc1 = SourceInfo::original(file_id, 7, 10);
    collector2.error_at("Title must be a string", loc1);

    // Warning at "John" (offsets 33-37)
    let loc2 = SourceInfo::original(file_id, 33, 37);
    let warning = DiagnosticMessageBuilder::warning("Author field should include email")
        .with_location(loc2)
        .add_hint("Use format: 'Name <email@example.com>'")
        .build();
    collector2.add(warning);

    println!("Collected diagnostics:");
    for text in collector2.to_text(Some(&ctx)) {
        println!("{}", text);
        println!();
    }

    println!("=== Example 3: JSON output for all diagnostics ===\n");

    let json_array: Vec<_> = collector2
        .diagnostics()
        .iter()
        .map(|d| d.to_json())
        .collect();

    println!("{}", serde_json::to_string_pretty(&json_array).unwrap());

    println!("\n=== Example 4: Continuing vs. failing fast ===\n");

    let mut collector3 = SimpleCollector::new();

    // In some subsystems, we collect all errors before failing
    for i in 1..=3 {
        collector3.error(format!("Error in item {}", i));
    }

    // Check at the end
    if collector3.has_errors() {
        eprintln!(
            "Processing failed with {} errors",
            collector3.diagnostics().len()
        );
        eprintln!("\nErrors:");
        for diag in collector3.diagnostics() {
            eprintln!("  - {}", diag.title);
        }
    }
}

examples/renderer_selection.rs (line 29)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/with_location.rs (line 24)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 22)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn problem(self, stmt: impl Into<MessageContent>) -> Self

Set the problem statement.

Following tidyverse guidelines, the problem statement should:

• Start with a general, concise statement
• Use “must” for requirements or “can’t” for impossibilities
• Be specific about types/expectations

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Invalid input")
    .problem("`n` must be a numeric vector, not a character vector")
    .build();

Examples found in repository

examples/renderer_selection.rs (line 30)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/builder_api.rs (line 12)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

examples/with_location.rs (line 25)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 23)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn add_detail(self, detail: impl Into<MessageContent>) -> Self

Add an error detail (displayed with error/cross bullet).

Error details provide specific information about what went wrong. Following tidyverse guidelines:

• Keep sentences short and specific
• Reveal location, name, or content of problematic input
• Limit to 5 total details (error + info) to avoid overwhelming users

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Incompatible lengths")
    .add_detail("`x` has length 3")
    .add_detail("`y` has length 5")
    .build();

assert_eq!(error.details.len(), 2);

Examples found in repository

examples/builder_api.rs (line 13)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

examples/with_location.rs (line 26)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 69)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn add_detail_at( self, detail: impl Into<MessageContent>, location: SourceInfo, ) -> Self

Add an error detail with a source location.

This allows adding contextual information that points to specific locations in the source code, creating rich multi-location error messages.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Mismatched brackets")
    .add_detail_at("Opening bracket here", opening_location)
    .add_detail_at("But no closing bracket found", end_location)
    .build();

pub fn add_info(self, info: impl Into<MessageContent>) -> Self

Add an info detail (displayed with info bullet).

Info details provide additional context or explanatory information.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Missing file")
    .add_detail("Could not find `config.yaml`")
    .add_info("Default configuration will be used")
    .build();

Examples found in repository

examples/builder_api.rs (line 25)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

pub fn add_info_at( self, info: impl Into<MessageContent>, location: SourceInfo, ) -> Self

Add an info detail with a source location.

pub fn add_note(self, note: impl Into<MessageContent>) -> Self

Add a note detail (displayed with plain bullet).

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Parse error")
    .add_note("This is an experimental feature")
    .build();

pub fn add_note_at( self, note: impl Into<MessageContent>, location: SourceInfo, ) -> Self

Add a note detail with a source location.

pub fn add_faded_at( self, content: impl Into<MessageContent>, location: SourceInfo, ) -> Self

Add a faded detail with a source location.

Rendered with the same dim grey colour Ariadne uses for unlabelled source characters, so it visually “punches a hole” in any wider label that also covers the same column range. Useful for excluding block-quote prefixes or other prefix decorations from the highlight of a multi-line span.

pub fn add_hint(self, hint: impl Into<MessageContent>) -> Self

Add a hint for fixing the error.

Following tidyverse guidelines, hints should:

• Only be included when the problem source is clear and common
• Provide straightforward fix suggestions
• End with a question mark if suggesting action

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Function not found")
    .problem("Could not find function `summarise()`")
    .add_hint("Did you mean `summarize()`?")
    .build();

assert_eq!(error.hints.len(), 1);

Examples found in repository

examples/renderer_selection.rs (line 31)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/builder_api.rs (line 14)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

examples/with_location.rs (line 27)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/diagnostic_collector.rs (line 98)

fn main() {
    println!("=== Example 1: Accumulating multiple errors ===\n");

    let mut collector = SimpleCollector::new();

    // Simulate validating a YAML file
    collector.error("Missing required field 'title'");
    collector.warn("Field 'description' is deprecated");
    collector.error("Invalid value for 'format': expected string, got number");

    if collector.has_errors() {
        println!(
            "Validation failed with {} diagnostics:",
            collector.diagnostics().len()
        );
        for text in collector.to_text(None) {
            println!("{}", text);
        }
    }

    println!("\n=== Example 2: Errors with source locations ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "config.yml".to_string(),
        Some("title: 123\nformat: html\nauthor: John\n".to_string()),
    );

    let mut collector2 = SimpleCollector::new();

    // Error in "title: 123" (offsets 7-10)
    let loc1 = SourceInfo::original(file_id, 7, 10);
    collector2.error_at("Title must be a string", loc1);

    // Warning at "John" (offsets 33-37)
    let loc2 = SourceInfo::original(file_id, 33, 37);
    let warning = DiagnosticMessageBuilder::warning("Author field should include email")
        .with_location(loc2)
        .add_hint("Use format: 'Name <email@example.com>'")
        .build();
    collector2.add(warning);

    println!("Collected diagnostics:");
    for text in collector2.to_text(Some(&ctx)) {
        println!("{}", text);
        println!();
    }

    println!("=== Example 3: JSON output for all diagnostics ===\n");

    let json_array: Vec<_> = collector2
        .diagnostics()
        .iter()
        .map(|d| d.to_json())
        .collect();

    println!("{}", serde_json::to_string_pretty(&json_array).unwrap());

    println!("\n=== Example 4: Continuing vs. failing fast ===\n");

    let mut collector3 = SimpleCollector::new();

    // In some subsystems, we collect all errors before failing
    for i in 1..=3 {
        collector3.error(format!("Error in item {}", i));
    }

    // Check at the end
    if collector3.has_errors() {
        eprintln!(
            "Processing failed with {} errors",
            collector3.diagnostics().len()
        );
        eprintln!("\nErrors:");
        for diag in collector3.diagnostics() {
            eprintln!("  - {}", diag.title);
        }
    }
}

examples/custom_rendering.rs (line 24)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn build(self) -> DiagnosticMessage

Build the diagnostic message.

This consumes the builder and returns the constructed DiagnosticMessage.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let error = DiagnosticMessageBuilder::error("Parse error")
    .problem("Invalid syntax")
    .build();

assert_eq!(error.title, "Parse error");

Examples found in repository

examples/diagnostic_collector.rs (line 41)

    fn error_at(&mut self, message: impl Into<String>, location: SourceInfo) {
        self.add(
            DiagnosticMessageBuilder::error(message.into())
                .with_location(location)
                .build(),
        );
    }

    fn has_errors(&self) -> bool {
        self.diagnostics
            .iter()
            .any(|d| d.kind == DiagnosticKind::Error)
    }

    fn diagnostics(&self) -> &[DiagnosticMessage] {
        &self.diagnostics
    }

    fn to_text(&self, ctx: Option<&SourceContext>) -> Vec<String> {
        self.diagnostics.iter().map(|d| d.to_text(ctx)).collect()
    }
}

fn main() {
    println!("=== Example 1: Accumulating multiple errors ===\n");

    let mut collector = SimpleCollector::new();

    // Simulate validating a YAML file
    collector.error("Missing required field 'title'");
    collector.warn("Field 'description' is deprecated");
    collector.error("Invalid value for 'format': expected string, got number");

    if collector.has_errors() {
        println!(
            "Validation failed with {} diagnostics:",
            collector.diagnostics().len()
        );
        for text in collector.to_text(None) {
            println!("{}", text);
        }
    }

    println!("\n=== Example 2: Errors with source locations ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "config.yml".to_string(),
        Some("title: 123\nformat: html\nauthor: John\n".to_string()),
    );

    let mut collector2 = SimpleCollector::new();

    // Error in "title: 123" (offsets 7-10)
    let loc1 = SourceInfo::original(file_id, 7, 10);
    collector2.error_at("Title must be a string", loc1);

    // Warning at "John" (offsets 33-37)
    let loc2 = SourceInfo::original(file_id, 33, 37);
    let warning = DiagnosticMessageBuilder::warning("Author field should include email")
        .with_location(loc2)
        .add_hint("Use format: 'Name <email@example.com>'")
        .build();
    collector2.add(warning);

    println!("Collected diagnostics:");
    for text in collector2.to_text(Some(&ctx)) {
        println!("{}", text);
        println!();
    }

    println!("=== Example 3: JSON output for all diagnostics ===\n");

    let json_array: Vec<_> = collector2
        .diagnostics()
        .iter()
        .map(|d| d.to_json())
        .collect();

    println!("{}", serde_json::to_string_pretty(&json_array).unwrap());

    println!("\n=== Example 4: Continuing vs. failing fast ===\n");

    let mut collector3 = SimpleCollector::new();

    // In some subsystems, we collect all errors before failing
    for i in 1..=3 {
        collector3.error(format!("Error in item {}", i));
    }

    // Check at the end
    if collector3.has_errors() {
        eprintln!(
            "Processing failed with {} errors",
            collector3.diagnostics().len()
        );
        eprintln!("\nErrors:");
        for diag in collector3.diagnostics() {
            eprintln!("  - {}", diag.title);
        }
    }
}

examples/renderer_selection.rs (line 32)

fn main() {
    let mut ctx = SourceContext::new();
    let source = "title: My Document\nformat:\n  html:\n    theme: nosuchtheme\n";
    let file_id = ctx.add_file("_quarto.yml".to_string(), Some(source.to_string()));

    // Point at `nosuchtheme` on line 4 (byte offsets into `source`).
    let start = source.find("nosuchtheme").unwrap();
    let location = SourceInfo::original(file_id, start, start + "nosuchtheme".len());

    let diag = DiagnosticMessageBuilder::error("Unknown theme")
        .with_code("Q-14-1")
        .with_location(location)
        .problem("`nosuchtheme` is not a known Quarto theme")
        .add_hint("Did you mean `cosmo`, `darkly`, or `flatly`?")
        .build();

    // Disable hyperlinks so the output is path-stable in a demo.
    let opts = TextRenderOptions {
        enable_hyperlinks: false,
    };

    // `None` uses the default renderer for the enabled features.
    println!("=== default renderer (None) ===\n");
    println!("{}", diag.to_text_with_renderer(Some(&ctx), &opts, None));

    #[cfg(feature = "ariadne")]
    {
        println!("=== SourceRenderer::Ariadne ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::Ariadne))
        );
    }

    #[cfg(feature = "annotate-snippets")]
    {
        println!("=== SourceRenderer::AnnotateSnippets ===\n");
        println!(
            "{}",
            diag.to_text_with_renderer(Some(&ctx), &opts, Some(SourceRenderer::AnnotateSnippets),)
        );
    }
}

examples/builder_api.rs (line 15)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

examples/with_location.rs (line 28)

fn main() {
    println!("=== Example 1: Error with source location ===\n");

    // Create a source context
    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "example.qmd".to_string(),
        Some("title: My Document\nauthor: John Doe\ndate: 2024-01-01\n".to_string()),
    );

    // Create a location (let's say there's an error in "My Document" - offsets 7 to 18)
    let location = SourceInfo::original(file_id, 7, 18);

    let error = DiagnosticMessageBuilder::error("Invalid title format")
        .with_code("Q-1-10")
        .with_location(location)
        .problem("Title must be a string, not a complex object")
        .add_detail("Title value starts at this location")
        .add_hint("Ensure the title is a simple quoted string")
        .build();

    // Render WITHOUT context - shows offset
    println!("Without context:");
    println!("{}", error.to_text(None));

    println!("\n---\n");

    // Render WITH context - shows file path and line:column
    println!("With context:");
    println!("{}", error.to_text(Some(&ctx)));

    println!("\n=== Example 2: Multiple locations ===\n");

    let another_ctx = SourceContext::new();

    // Note: This example shows the API, but without actual file content,
    // the rendering will still show offsets. In real usage with proper
    // SourceContext, this would show rich source snippets via ariadne.

    let location2 = SourceInfo::original(quarto_source_map::FileId(0), 100, 110);

    let error2 = DiagnosticMessageBuilder::error("Unclosed code block")
        .with_code("Q-2-301")
        .with_location(location2)
        .problem("Code block started but never closed")
        .add_detail("The opening ``` was found but no closing ``` before end of block")
        .add_hint("Add a closing ``` on a new line")
        .build();

    println!("{}", error2.to_text(Some(&another_ctx)));

    println!("\n=== Example 3: JSON output with location ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());
}

examples/custom_rendering.rs (line 25)

fn main() {
    println!("=== Example 1: Default rendering (with hyperlinks) ===\n");

    let mut ctx = SourceContext::new();
    let file_id = ctx.add_file(
        "document.qmd".to_string(),
        Some("# My Document\n\nSome content here.\n".to_string()),
    );

    let location = SourceInfo::original(file_id, 15, 27);

    let error = DiagnosticMessageBuilder::error("Parse error")
        .with_code("Q-2-100")
        .with_location(location)
        .problem("Invalid markdown syntax")
        .add_hint("Check the markdown formatting")
        .build();

    // Default rendering includes OSC 8 hyperlinks for file paths
    let default_text = error.to_text(Some(&ctx));
    println!("{}", default_text);

    println!("\n=== Example 2: Rendering without hyperlinks (for tests) ===\n");

    // Disable hyperlinks - useful for snapshot testing where absolute paths
    // would cause differences between machines
    let options = TextRenderOptions {
        enable_hyperlinks: false,
    };

    let no_hyperlink_text = error.to_text_with_options(Some(&ctx), &options);
    println!("{}", no_hyperlink_text);

    println!("\n=== Example 3: Comparing outputs ===\n");

    // Show the difference in output
    println!("With hyperlinks enabled:");
    println!("  Length: {} bytes", default_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        default_text.contains("\x1b]8;")
    );

    println!("\nWith hyperlinks disabled:");
    println!("  Length: {} bytes", no_hyperlink_text.len());
    println!(
        "  Contains OSC 8 codes: {}",
        no_hyperlink_text.contains("\x1b]8;")
    );

    println!("\n=== Example 4: JSON output (no hyperlinks) ===\n");

    let json = error.to_json();
    println!("{}", serde_json::to_string_pretty(&json).unwrap());

    println!("\n=== Example 5: Multiple diagnostics with custom rendering ===\n");

    let error2 = DiagnosticMessageBuilder::error("Type mismatch")
        .with_code("Q-1-15")
        .problem("Expected string, found number")
        .add_detail("Value: 42")
        .add_detail("Expected type: string")
        .build();

    let error3 = DiagnosticMessageBuilder::error("Missing field")
        .with_code("Q-1-20")
        .problem("Required field 'author' not found")
        .add_hint("Add an 'author' field to your configuration")
        .build();

    let errors = [error, error2, error3];

    // Render all with consistent options
    let no_hyperlinks = TextRenderOptions {
        enable_hyperlinks: false,
    };

    for (i, err) in errors.iter().enumerate() {
        println!("Error {}:", i + 1);
        println!("{}", err.to_text_with_options(Some(&ctx), &no_hyperlinks));
        println!();
    }
}

pub fn build_with_validation(self) -> (DiagnosticMessage, Vec<String>)

Build with validation.

This validates the message structure according to tidyverse guidelines:

• Warns if there’s no problem statement (recommended but not required)
• Warns if there are more than 5 details (overwhelming for users)
• Future: Could check that hints end with ‘?’

Returns warnings as a Vec of strings. An empty Vec means validation passed.

Example

use quarto_error_reporting::DiagnosticMessageBuilder;

let (error, warnings) = DiagnosticMessageBuilder::error("Test error")
    .build_with_validation();

// Warns because there's no problem statement
assert!(!warnings.is_empty());

Examples found in repository

examples/builder_api.rs (line 55)

fn main() {
    println!("=== Example 1: Simple builder usage ===\n");

    let error1 = DiagnosticMessageBuilder::error("Invalid input")
        .problem("Value must be numeric")
        .add_detail("Found text in column 3")
        .add_hint("Check the input file format")
        .build();

    println!("{}", error1.to_text(None));

    println!("\n=== Example 2: Tidyverse four-part structure ===\n");

    let error2 = DiagnosticMessageBuilder::error("Incompatible types")
        .problem("Cannot combine date and datetime types")
        .add_detail("`x` has type `date`")
        .add_detail("`y` has type `datetime`")
        .add_info("Both values come from the same data source")
        .add_hint("Convert both to the same type first?")
        .build();

    println!("{}", error2.to_text(None));

    println!("\n=== Example 3: Multiple details and hints ===\n");

    let error3 = DiagnosticMessageBuilder::error("Schema validation failed")
        .problem("Configuration does not match expected schema")
        .add_detail("Property `title` has type `number`")
        .add_detail("Expected type is `string`")
        .add_detail("Property `author` is missing")
        .add_info("Schema is defined in `_quarto.yml`")
        .add_hint("Did you forget quotes around the title?")
        .add_hint("Add an `author` field to the configuration")
        .build();

    println!("{}", error3.to_text(None));

    println!("\n=== Example 4: Builder validation ===\n");

    // This will trigger validation warnings
    let (msg, warnings) = DiagnosticMessageBuilder::error("Validation test")
        .add_detail("Detail 1")
        .add_detail("Detail 2")
        .add_detail("Detail 3")
        .add_detail("Detail 4")
        .add_detail("Detail 5")
        .add_detail("Detail 6") // Too many!
        .build_with_validation();

    println!("{}", msg.to_text(None));

    if !warnings.is_empty() {
        println!("\nValidation warnings:");
        for warning in warnings {
            println!("  ⚠ {}", warning);
        }
    }
}

Trait Implementations

impl Clone for DiagnosticMessageBuilder

fn clone(&self) -> DiagnosticMessageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagnosticMessageBuilder

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

Formats the value using the given formatter.