Class ParseDiagnostic

Structured, machine-readable description of a parse failure, produced by TryParse(string, out AstNode?, out ParseDiagnostic?) and carried by FormulaParseException. It reports where the error is (Position, Length), a stable Code, the tokens that would have been valid (Expected), and a caret Snippet for display.

public sealed class ParseDiagnostic

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Stable machine-readable error classification.

public ParseErrorCode Code { get; }

Token descriptions that would have been valid at this position (may be empty).

public IReadOnlyList<string> Expected { get; }

Length of the offending span; 0 at end of input (rendered as a single caret).

public int Length { get; }

Human-readable message (also the Message when thrown).

public string Message { get; }

Zero-based index into Source where the offending span begins.

public int Position { get; }

A two-line caret snippet: the source, then a line pointing at the offending span with ^. Useful for terminals, logs and error UIs.

public string Snippet { get; }

The source text this diagnostic refers to (empty when unavailable).

public string Source { get; }

Returns a string that represents the current object.

public override string ToString()