Dart Documentation › petitparser › Failure

Failure class

An immutable parse result in case of a failed parse.

class Failure extends Result {

 final String _message;

 const Failure(buffer, position, this._message) : super(buffer, position);

 bool get isFailure => true;

 dynamic get value { throw new ParserError(this); }

 String get message => _message;

 String toString() => 'Failure[${toPositionString()}]: $_message';

}

Extends

Context > Result > Failure

Constructors

const Failure(buffer, position, String _message) #

const Failure(buffer, position, this._message) : super(buffer, position);

Properties

final buffer #

inherited from Context

The buffer we are working on. 

dynamic get buffer => _buffer;

final bool isFailure #

Returns true if this result indicates a parse failure.

docs inherited from Context 
bool get isFailure => true;

final bool isSuccess #

inherited from Context

Returns true if this result indicates a parse success. 

bool get isSuccess => false;

final String message #

Returns the parse message of the current context.

docs inherited from Result 
String get message => _message;

final int position #

inherited from Context

The current position in the buffer. 

int get position => _position;

final result #

inherited from Result 
dynamic get result => value;

final value #

Returns the parse result of the current context.

docs inherited from Result 
dynamic get value { throw new ParserError(this); }

Methods

Result failure(String message, [int position]) #

inherited from Context

Returns a result indicating a parse failure. 

Result failure(String message, [int position]) {
 return new Failure(_buffer, position == null ? _position : position, message);
}

Result success(result, [int position]) #

inherited from Context

Returns a result indicating a parse success. 

Result success(dynamic result, [int position]) {
 return new Success(_buffer, position == null ? _position : position, result);
}

String toPositionString() #

inherited from Context 
String toPositionString() {
 if (_buffer is String) {
   var lineAndColumn = Token.lineAndColumnOf(buffer, position);
   return '${lineAndColumn[0]}:${lineAndColumn[1]}';
 } else {
   return '${position}';
 }
}

String toString() #

Returns a human readable string of the current context

docs inherited from Context 
String toString() => 'Failure[${toPositionString()}]: $_message';