Struct tfm::pl::ParseWarning

pub struct ParseWarning {
    pub span: Range<usize>,
    pub knuth_pltotf_offset: Option<usize>,
    pub kind: ParseWarningKind,
}

Warning generated while parsing a property list file.

Fields

span: Range<usize>

Location of the part of the property list file that generates this warning.

The span is in number of Unicode code points, not bytes.

knuth_pltotf_offset: Option<usize>

Point in the file that Knuth’s pltotf flags as problematic.

Most warnings in pltotf are printed with a context line. This looks like this:

PARAMETER index must not be zero (line 9).
(PARAMETER D 0
               D 5)  

The context line is printed over 2 lines in the terminal, with the break occurring at the part of the line that triggered the warning.

This field gives the offset of the break within the entire file. The offset is in number of Unicode code points, not bytes. For warnings that don’t have a context line (like next larger warnings) this field has a value of None.

kind: ParseWarningKind

Kind of the warning.

Implementations

impl ParseWarning

pub fn pltotf_message(&self, pl_source: &str) -> String

impl ParseWarning

pub fn ariadne_report<'a>( &self, file_name: &'a str, ) -> Report<'a, (&'a str, Range<usize>)>

Trait Implementations

impl Clone for ParseWarning

fn clone(&self) -> ParseWarning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseWarning

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

Formats the value using the given formatter.

impl PartialEq for ParseWarning

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ParseWarning

impl StructuralPartialEq for ParseWarning