tiny.zen.Diagnostic

1/// Fixed-capacity detail for a failed page, equation, heading, or inline feature.2///3/// Supply its address through Markdown or site options. After an error, inspect4/// `page()`, the feature source, `reason`, and `offset`, then call `reset` before5/// reuse.6pub const Diagnostic = struct {7    page_buffer: [max_page_bytes]u8 = undefined,8    page_len: usize = 0,9    equation_buffer: [max_equation_bytes]u8 = undefined,10    equation_len: usize = 0,11    inline_buffer: [max_inline_bytes]u8 = undefined,12    inline_len: usize = 0,13    /// Short cause suitable for a repair message; empty when no detail is captured.14    reason: []const u8 = "",15    /// Byte offset in the original inline source, heading feature, or equation.16    /// It can lie beyond a bounded or sanitized captured excerpt.17    offset: usize = 0,1819    /// Returns the page path, truncated with an ellipsis if needed.20    pub fn page(self: *const Diagnostic) []const u8 {21        return self.page_buffer[0..self.page_len];22    }2324    /// Returns the captured equation, truncated with an ellipsis if needed.25    pub fn equation(self: *const Diagnostic) []const u8 {26        return self.equation_buffer[0..self.equation_len];27    }2829    /// Returns a bounded UTF-8-safe source prefix for context, not indexing.30    /// Invalid bytes become `?` and excess source ends in `...`.31    pub fn inlineSource(self: *const Diagnostic) []const u8 {32        return self.inline_buffer[0..self.inline_len];33    }3435    /// Clears captured detail before a retry or unrelated operation.36    pub fn reset(self: *Diagnostic) void {37        self.* = .{};38    }3940    pub fn setPage(self: *Diagnostic, path: []const u8) void {41        self.page_len = copyEllipsized(&self.page_buffer, path);42    }4344    pub fn setEquation(self: *Diagnostic, source: []const u8, detail: math.Diagnostic) void {45        self.equation_len = copyEllipsized(&self.equation_buffer, source);46        self.inline_len = 0;47        self.reason = detail.reason;48        self.offset = detail.offset;49    }5051    pub fn setHeading(self: *Diagnostic, reason: []const u8, offset: usize) void {52        self.equation_len = 0;53        self.inline_len = 0;54        self.reason = reason;55        self.offset = offset;56    }5758    pub fn setInline(self: *Diagnostic, source: []const u8, reason: []const u8, offset: usize) void {59        self.equation_len = 0;60        self.inline_len = copyEllipsized(&self.inline_buffer, source);61        self.reason = reason;62        self.offset = offset;63    }64};

1/// Fixed-capacity source-local detail for rendering and publication failures.2pub const Diagnostic = diagnostic.Diagnostic;