ParseResult

Abstract Value Members

abstract def errors: Seq[ParseError]

A sequence of all ParseErrors that occurred.
abstract def get: A

Attributes
protected
abstract def isSuccessful: Boolean

Is the result a success, i.e.
Is the result a success, i.e. either a ParseSuccess or a PartialParseSuccess.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def collect[B](pf: PartialFunction[A, B]): ParseResult[B]

Apply a PartialFunction to the result value.
Apply a PartialFunction to the result value. If the pf function isn't defined for the result value a ParseFailure is returned.
final def collect[B](otherwise: ⇒ ParseError)(pf: PartialFunction[A, B]): ParseResult[B]

Apply a PartialFunction to the result value.
Apply a PartialFunction to the result value. If the pf isn't defined for the result value, a ParseFailure with the otherwise error is returned.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def filter(f: (A) ⇒ Boolean): ParseResult[A]

f
Predicate to filter the ParseResult by
returns
this if the test passes, or ParseFailure if the test fails.
def filter(error: ⇒ ParseError)(f: (A) ⇒ Boolean): ParseResult[A]

error
The error to use if the test fails.
f
Predicate to filter the ParseResult by
returns
if the result is successful and the filter fails ParseFailure is returned
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[B](f: (A) ⇒ ParseResult[B]): ParseResult[B]

FlatMap over the result value.
FlatMap over the result value.
One thing to note is that if this is a PartialParseSuccess, then the errors are prepended to the result of calling f on the value. So for example, if f returns a ParseSuccess, but this is a PartialParseSuccess the final result will be a PartialParseSuccess containing the result from f and the errors from this.
def fold[B](onFailure: (Seq[ParseError]) ⇒ B)(onSuccess: (A) ⇒ B): B

Handle both success and failure.
Handle both success and failure.
onFailure
Function to handle a ParseFailure.
onSuccess
Function to process a successful parse.
def foreach(f: (A) ⇒ Unit): Unit

Execute f on the result value if and only if this ParseResult is successful.
Execute f on the result value if and only if this ParseResult is successful.
f
the function to execute.

Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getOrElse[B >: A](otherwise: ⇒ B): B

returns
the result value, unless this is a ParseFailure in which case return otherwise.
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[B](f: (A) ⇒ B): ParseResult[B]

Map a function over the result value.
Map a function over the result value. The level of success, and any errors are propagated.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def orElse[B >: A](otherwise: ⇒ ParseResult[B]): ParseResult[B]

returns
this if this is successful otherwise return otherwise.
def recoverPartial[B >: A](otherwise: ⇒ B): ParseResult[B]

If this is a ParseFailure recover as a PartialParseSuccess containing otherwise so that the errors are kept.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toOption: Option[A]

Convert to an Option
Convert to an Option
returns
a Some containing the result if successful, or a None if a failure
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFilter(f: (A) ⇒ Boolean): ParseResult[A]

Alias for filter

Related Docs: object ParseResult | package xtract

sealed trait ParseResult[+A] extends AnyRef

Abstract Value Members

abstract def errors: Seq[ParseError]

abstract def get: A

abstract def isSuccessful: Boolean

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def collect[B](pf: PartialFunction[A, B]): ParseResult[B]

final def collect[B](otherwise: ⇒ ParseError)(pf: PartialFunction[A, B]): ParseResult[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def filter(f: (A) ⇒ Boolean): ParseResult[A]

def filter(error: ⇒ ParseError)(f: (A) ⇒ Boolean): ParseResult[A]

def finalize(): Unit

def flatMap[B](f: (A) ⇒ ParseResult[B]): ParseResult[B]

def fold[B](onFailure: (Seq[ParseError]) ⇒ B)(onSuccess: (A) ⇒ B): B

def foreach(f: (A) ⇒ Unit): Unit

final def getClass(): Class[_]

def getOrElse[B >: A](otherwise: ⇒ B): B

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def map[B](f: (A) ⇒ B): ParseResult[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def orElse[B >: A](otherwise: ⇒ ParseResult[B]): ParseResult[B]

def recoverPartial[B >: A](otherwise: ⇒ B): ParseResult[B]

final def synchronized[T0](arg0: ⇒ T0): T0

def toOption: Option[A]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFilter(f: (A) ⇒ Boolean): ParseResult[A]

Inherited from AnyRef

Inherited from Any

Ungrouped