Class ParseError<TToken>
Represents an error encountered during parsing.
Inheritance
- Object
- ParseError<TToken>
Implements
- IEquatable<ParseError<TToken>>
Declaration
public class ParseError<TToken> : ObjectType Parameters
| Name | Description |
|---|---|
TToken |
The type of tokens in the input stream |
Properties
EOF
Was the parse error due to encountering the end of the input stream while parsing?
Declaration
public bool EOF { get; }Property Value
| Type | Description |
|---|---|
True if and only if the parse error was due to encountering the end of the input stream while parsing |
ErrorPos
The position in the input stream at which the parse error occurred
Declaration
public SourcePos ErrorPos { get; }Property Value
| Type | Description |
|---|---|
The position in the input stream at which the parse error occurred |
ErrorPosDelta
The offset in the input stream at which the parse error occurred
Declaration
public SourcePosDelta ErrorPosDelta { get; }Property Value
| Type | Description |
|---|---|
The offset in the input stream at which the parse error occurred |
Expected
A collection of expected inputs
Declaration
public IEnumerable<Expected<TToken>> Expected { get; }Property Value
| Type | Description |
|---|---|
IEnumerable<Expected<TToken>> |
The collection of expected inputs |
Message
A custom error message
Declaration
public string Message { get; }Property Value
| Type | Description |
|---|---|
A custom error message, or null if the error was created without a custom error message |
Unexpected
The token which caused the parse error.
Declaration
public Maybe<TToken> Unexpected { get; }Property Value
| Type | Description |
|---|---|
Maybe<TToken> |
The token which caused the parse error, or Nothing<T>() if the parse error was not caused by an unexpected token. |
Methods
Equals(ParseError<TToken>)
Declaration
public bool Equals(ParseError<TToken> other)Parameters
| Type | Name | Description |
|---|---|---|
ParseError<TToken> |
other |
Returns
| Type | Description |
|---|---|
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
obj |
Returns
| Type | Description |
|---|---|
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
RenderErrorMessage(Nullable<SourcePos>)
Render the parse error as a string
Declaration
public string RenderErrorMessage(Nullable<SourcePos> initialSourcePos = null)Parameters
| Type | Name | Description |
|---|---|---|
initialSourcePos |
Returns
| Type | Description |
|---|---|
An error message |
ToString()
Render the parse error as a string
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
An error message |
ToString(SourcePos)
Render the parse error as a string
Declaration
public string ToString(SourcePos initialSourcePos)Parameters
| Type | Name | Description |
|---|---|---|
initialSourcePos |
Returns
| Type | Description |
|---|---|
An error message |
Operators
Equality(ParseError<TToken>, ParseError<TToken>)
Declaration
public static bool operator ==(ParseError<TToken> left, ParseError<TToken> right)Parameters
| Type | Name | Description |
|---|---|---|
ParseError<TToken> |
left |
|
ParseError<TToken> |
right |
Returns
| Type | Description |
|---|---|
Inequality(ParseError<TToken>, ParseError<TToken>)
Declaration
public static bool operator !=(ParseError<TToken> left, ParseError<TToken> right)Parameters
| Type | Name | Description |
|---|---|---|
ParseError<TToken> |
left |
|
ParseError<TToken> |
right |
Returns
| Type | Description |
|---|---|