Struct tvix_eval::warnings::EvalWarning

pub struct EvalWarning {
    pub kind: WarningKind,
    pub span: Span,
}

Fields

kind: WarningKind

span: Span

Implementations

impl EvalWarning

pub fn fancy_format_str(&self, source: &SourceCode) -> String

Render a fancy, human-readable output of this warning and return it as a String. Note that this version of the output does not include any colours or font styles.

pub fn fancy_format_stderr(&self, source: &SourceCode)

Render a fancy, human-readable output of this warning and print it to stderr. If rendered in a terminal that supports colours and font styles, the output will include those.

fn span_label(&self) -> Option<String>

Create the optional span label displayed as an annotation on the underlined span of the warning.

fn message(&self, source: &SourceCode) -> String

Create the primary warning message displayed to users for a warning.

fn code(&self) -> &'static str

Return the unique warning code for this variant which can be used to refer users to documentation.

fn diagnostic(&self, source: &SourceCode) -> Diagnostic

Trait Implementations

impl Debug for EvalWarning

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

Formats the value using the given formatter.