Struct Formatted 

pub struct Formatted { /* private fields */ }

Formatted compiler error type undefined value x –> file.leo: 2:8 | 2 | let a = x; | ^ | = help: Initialize a variable x first.

Stores all error components as plain owned fields. The ariadne Report is built on the fly in Display::fmt.

Implementations

impl Formatted

pub fn new_from_span<S>( message: S, help: Option<String>, code: i32, type_: String, error: bool, span: Span, labels: Vec<Label>, ) -> Self

where S: ToString,

Creates a formatted error from a span and labels.

pub fn error( code_prefix: &str, code: i32, message: impl ToString, span: Span, ) -> Self

Create a new error.

pub fn warning( code_prefix: &str, code: i32, message: impl ToString, span: Span, ) -> Self

Create a new warning.

pub fn with_help(self, help: impl Display) -> Self

pub fn with_note(self, note: impl Display) -> Self

pub fn with_label(self, label: Label) -> Self

pub fn with_labels(self, labels: impl IntoIterator<Item = Label>) -> Self

pub fn exit_code(&self) -> i32

Gets the exit code.

pub fn error_code(&self) -> String

Gets a unique error identifier.

pub fn warning_code(&self) -> String

Gets a unique warning identifier.

pub fn message(&self) -> &str

Return the diagnostic’s primary message without ariadne rendering.

Used by tooling consumers (notably leo-lsp) that need the bare message text rather than the formatted report. The returned slice borrows from the same allocation as the rest of the diagnostic and therefore stays valid for the lifetime of the Formatted value.

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

Return the diagnostic’s optional help text, if any.

leo-lsp appends this to the LSP diagnostic message so editor clients see the same hint that the CLI report would render.

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

Return the diagnostic’s optional follow-up note text, if any.

leo-lsp appends this to the LSP diagnostic message for parity with CLI-rendered reports.

pub fn is_error(&self) -> bool

Return whether this diagnostic was raised as an error rather than a warning.

LSP severity mapping depends on this flag instead of inspecting the rendered Error/Warning prefix in the formatted message.

pub fn span(&self) -> Span

Return the diagnostic’s primary span.

Callers must resolve this span against leo_span session globals to recover the originating source file before the surrounding session is torn down.

pub fn labels(&self) -> impl Iterator<Item = &Label>

Iterate the diagnostic’s secondary labels in declaration order.

Labels carry their own span and human-readable message, which leo-lsp surfaces as Diagnostic.relatedInformation when the client supports it.

pub fn diagnostic_view(&self) -> DiagnosticView<'_>

Borrow this diagnostic as a plain structured view.

The returned DiagnosticView exposes the same fields that are used when rendering the ariadne report, without round-tripping through a formatted string. Consumers like leo-lsp use the view to build LSP Diagnostic payloads without parsing rendered output.

Trait Implementations

impl Debug for Formatted

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

Formats the value using the given formatter.

impl Display for Formatted

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

Formats the value using the given formatter.

impl Error for Formatted

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Formatted> for LeoError

fn from(source: Formatted) -> Self

Converts to this type from the input type.

impl From<Formatted> for LeoWarning

fn from(source: Formatted) -> Self

Converts to this type from the input type.