Struct SimpleErrorReport 

pub struct SimpleErrorReport<'a> {
    pub error_report: &'a ErrorReport,
}

Simple implementation of SubmitErrorReport.

Generates a structured, markdown-formatted error report suitable for both humans and AI/LLMs. Does not generate URLs — the report is the output.

Respects the NO_COLOR environment variable: when set, terminal hyperlinks are disabled, producing clean plain text (markdown is unaffected).

Example

use charon_error::prelude::*;
use charon_error::prelude::simple_er::*;
use charon_error::LinkDebugIde;

SimpleErrorReport::setup_global_config(SimpleERGlobalSettings {
    link_format: LinkDebugIde::Vscode,
}).unwrap_error();

Fields

error_report: &'a ErrorReport

Reference to the error report being formatted.

Implementations

impl<'a> SimpleErrorReport<'a>

pub fn setup_global_config( config: SimpleERGlobalSettings, ) -> Result<(), ErrorReport>

Initialize the global simple report configuration. Must be called once at startup.

Returns an error if called more than once.

pub fn get_global_config() -> Result<RwLockReadGuard<'static, SimpleERGlobalSettings>, ErrorReport>

Read the global simple report configuration. Returns an error if not yet set.

Trait Implementations

impl<'a> Clone for SimpleErrorReport<'a>

fn clone(&self) -> SimpleErrorReport<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SimpleErrorReport<'a>

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

Formats the value using the given formatter.

impl<'a> SubmitErrorReport<'a> for SimpleErrorReport<'a>

fn new(error: &'a ErrorReport) -> Self

Create a new report wrapper from an error report reference.

fn get_error_report(&self) -> &ErrorReport

Return the ErrorReport containing the error stack.

fn get_title(&self) -> String

Return the title of the error.

fn create_message(&self) -> Result<String, ErrorReport>

Create the full user-facing error message with report instructions.

fn create_bug_report(&self) -> Result<String, ErrorReport>

Create the bug report body text (same content as the URL submission).

fn create_submit_url(&self) -> Result<Url, ErrorReport>

Create a URL that opens a pre-filled issue on the platform.

fn create_submit_url_limited( &self, _max_length: usize, ) -> Result<Url, ErrorReport>

Create a pre-filled issue URL, progressively removing detail to stay under max_length.

fn check_existing_reports(&self) -> Result<Url, ErrorReport>

Create a URL to search for existing reports with the same title.

fn truncate_string(text: String, limit: usize) -> String

Truncate a string to the given limit, respecting character boundaries.