Struct ErrorPanel 

pub struct ErrorPanel { /* private fields */ }

A panel specifically designed for error display.

Provides rich formatting for error messages including SQL context, position markers, hints, and SQLSTATE codes.

Implementations

impl ErrorPanel

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

Create a new error panel with title and message.

Example

use sqlmodel_console::renderables::ErrorPanel;

let panel = ErrorPanel::new("Connection Error", "Failed to connect to database");

pub fn severity(self, severity: ErrorSeverity) -> Self

Set error severity.

pub fn with_sql(self, sql: impl Into<String>) -> Self

Add SQL query context.

pub fn with_position(self, position: usize) -> Self

Add error position in SQL (1-indexed character position).

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

Add SQLSTATE code.

pub fn with_detail(self, detail: impl Into<String>) -> Self

Add detail message.

pub fn with_hint(self, hint: impl Into<String>) -> Self

Add hint for fixing the error.

pub fn add_context(self, line: impl Into<String>) -> Self

Add context line.

pub fn theme(self, theme: Theme) -> Self

Set the theme for styled output.

pub fn width(self, width: usize) -> Self

Set the panel width for styled output.

pub fn get_severity(&self) -> ErrorSeverity

Get the severity level.

pub fn get_title(&self) -> &str

Get the title.

pub fn get_message(&self) -> &str

Get the message.

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

Get the SQL query if set.

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

Get the SQL position if set.

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

Get the SQLSTATE code if set.

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

Get the detail message if set.

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

Get the hint if set.

pub fn get_context(&self) -> &[String]

Get the context lines.

pub fn render_plain(&self) -> String

Render as plain text.

Returns a structured plain text representation suitable for non-TTY environments or agent consumption.

pub fn render_styled(&self) -> String

Render as styled text with ANSI colors and box drawing.

Returns a rich panel representation with colored borders and formatted content.

pub fn to_json(&self) -> Value

Render as JSON-serializable structure.

Returns a JSON value suitable for structured logging or API responses.

Trait Implementations

impl Clone for ErrorPanel

fn clone(&self) -> ErrorPanel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorPanel

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

Formats the value using the given formatter.

impl Default for ErrorPanel

fn default() -> Self

Returns the “default value” for a type.