Struct Warning 

pub struct Warning {
    pub message: String,
    pub line: Option<usize>,
}

Something the document does that will not work, with where it is if that is known.

Lives here because both rux-style and rux-script raise these and neither depends on the other; this is already the crate that exists to hold what they pass between them. rux-runtime merges both sinks for the dev overlay, and rux check turns them into editor diagnostics.

line is a 1-based line in the file, not in the section that produced it: a position relative to a <style> block would send a reader to the wrong part of the file, which is worse than sending them nowhere. It is None wherever the stage that noticed the problem does not know where it was, and that is not a placeholder to be filled with a guess.

Fields

message: String

line: Option<usize>

Implementations

impl Warning

pub fn new(message: impl Into<String>) -> Warning

A warning whose position is not known.

pub fn at(message: impl Into<String>, line: usize) -> Warning

A warning at a known 1-based file line.

pub fn maybe_at(message: impl Into<String>, line: Option<usize>) -> Warning

Attach line if there is one, leaving the warning unplaced otherwise.

impl Warning

pub fn to_json(&self) -> String

{"message": …, "line": … }, with line present and null when unplaced so a consumer never has to tell “no position” from “field missing”.

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Warning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Warning

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

Formats the value using the given formatter.

impl Display for Warning

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

line 12: message, or just the message when it has no position. This is what the dev overlay shows, so it stays prose rather than becoming a path:line:col machine format.

impl Eq for Warning

impl PartialEq for Warning

fn eq(&self, other: &Warning) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Warning