Struct Warning 

pub struct Warning {
    pub path: FieldPath,
    pub span: Option<Span>,
    pub reason: String,
    pub fix: Option<String>,
}

A warning about a field of the spec.

Fields

path: FieldPath

The field it is about.

span: Option<Span>

Where that field is in the file, when it is written there.

reason: String

What is likely wrong.

fix: Option<String>

What to write instead.

Implementations

impl Warning

pub fn new(path: FieldPath, reason: impl Into<String>) -> Warning

A warning at path, not yet placed.

pub fn fix(self, fix: impl Into<String>) -> Warning

The warning, with its fix.

pub fn render(&self, file: &str) -> String

The three lines an author reads, naming file (isoloom.yml) on the first.

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl Display for Warning

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

Formats the value using the given formatter.

impl Eq for Warning

impl PartialEq for Warning

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Warning

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Warning