XmlReader

Abstract Value Members

abstract def read(xml: NodeSeq): ParseResult[A]

The core operation of an XmlReader, it converts an xml NodeSeq into a ParseResult of the desired type.
The core operation of an XmlReader, it converts an xml NodeSeq into a ParseResult of the desired type.
xml
The xml to read from.
returns
The ParseResult resulting from reading the xml.

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
def andThen[B](other: XmlReader[B])(implicit witness: <:<[A, NodeSeq]): XmlReader[B]

Similar to compose but with the operands reversed.
Similar to compose but with the operands reversed.
other
The XmlReader to compose this with.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Map a partial function over the XmlReader.
Map a partial function over the XmlReader. If the partial function isn't defined for the input, returns a ParseFailure.
def collect[B](otherwise: ⇒ ParseError)(f: PartialFunction[A, B]): XmlReader[B]

Map a partial function over the XmlReader.
Map a partial function over the XmlReader. If the partial function isn't defined for the input, returns a ParseFailure containing otherwise as its error.
def compose[B <: NodeSeq](r: XmlReader[B]): XmlReader[A]

Compose this XmlReader with another.
Compose this XmlReader with another.
r
An XmlReader that returns a NodeSeq result.
returns
New XmlReader that uses this XmlReader to read the result of r.
def default[B >: A](v: B): XmlReader[B]

Use a default value if unable to parse, always successful, drops any errors
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def filter(error: ⇒ ParseError)(p: (A) ⇒ Boolean): XmlReader[A]

Similar to filter(p:A=>Boolean):*, but allows you to supply the ParseError to use if the filter test fails.
Similar to filter(p:A=>Boolean):*, but allows you to supply the ParseError to use if the filter test fails.
error
The error to use if the filter fails.
p
The predicate to filter with
def filter(p: (A) ⇒ Boolean): XmlReader[A]

Filter the result of the XmlReader.
Filter the result of the XmlReader. It filters the resulting ParseResult after reading.
p
The predicate to filter with
def finalize(): Unit

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

Similar to map but does a flatMap on the ParseResult rather than a map.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Map the XmlReader.
Map the XmlReader. This converts one XmlReader into another (usually of a different type).
f
The mapping function.
returns
A new XmlReader that succeeds with result of calling f on the result of this if this succeeds.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optional: XmlReader[Option[A]]

Convert to a reader that always succeeds with an option (None if it would have failed).
Convert to a reader that always succeeds with an option (None if it would have failed). Any errors are dropped
def or[B >: A](other: XmlReader[B]): XmlReader[B]

returns
New XmlReader that succeeds if either this or v succeeds on the input. This has preference. If both fail the ParseFailure contains the errors from both.
def orElse[B >: A](v: ⇒ XmlReader[B]): XmlReader[B]

Like or but takes a by-name parameter and doesn't combine errors.
Like or but takes a by-name parameter and doesn't combine errors.
returns
New XmlReader that succeeds if either this or v succeeds on the input. this has preference.
def recover[B >: A](otherwise: B): XmlReader[B]

Recover from a failed parse, keeping any errors.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def tryMap[B](fe: (A) ⇒ ParseError)(f: (A) ⇒ B): XmlReader[B]

Try to map, and if there is an exception, return a failure with the supplied error
Try to map, and if there is an exception, return a failure with the supplied error
B
The type to map into.
fe
A function that returns the appropriate ParseError if mapping failed.
f
The mapping function.
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 |[B >: A](other: XmlReader[B]): XmlReader[B]

Alias for or

Related Docs: object XmlReader | package xtract

trait XmlReader[+A] extends AnyRef

Abstract Value Members

abstract def read(xml: NodeSeq): ParseResult[A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def andThen[B](other: XmlReader[B])(implicit witness: <:<[A, NodeSeq]): XmlReader[B]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def collect[B](f: PartialFunction[A, B]): XmlReader[B]

def collect[B](otherwise: ⇒ ParseError)(f: PartialFunction[A, B]): XmlReader[B]

def compose[B <: NodeSeq](r: XmlReader[B]): XmlReader[A]

def default[B >: A](v: B): XmlReader[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def filter(error: ⇒ ParseError)(p: (A) ⇒ Boolean): XmlReader[A]

def filter(p: (A) ⇒ Boolean): XmlReader[A]

def finalize(): Unit

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optional: XmlReader[Option[A]]

def or[B >: A](other: XmlReader[B]): XmlReader[B]

def orElse[B >: A](v: ⇒ XmlReader[B]): XmlReader[B]

def recover[B >: A](otherwise: B): XmlReader[B]

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

def toString(): String

def tryMap[B](fe: (A) ⇒ ParseError)(f: (A) ⇒ B): XmlReader[B]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def |[B >: A](other: XmlReader[B]): XmlReader[B]

Inherited from AnyRef

Inherited from Any

Ungrouped