DocParser

Instance Constructors

new DocParser(enableProfiling: Boolean = false)

Type Members

type Elem = DocLexer.Token

Definition Classes
DocParser → Parsers
case class Error extends NoSuccess with Product with Serializable

Definition Classes
Parsers
case class Failure extends NoSuccess with Product with Serializable

Definition Classes
Parsers
type Input = Reader[Elem]

Definition Classes
Parsers
sealed abstract class NoSuccess extends ParseResult[Nothing]

Definition Classes
Parsers
trait OnceParser[+T] extends Parser[T]

Definition Classes
Parsers
sealed abstract class ParseResult[+T] extends AnyRef

Definition Classes
Parsers
abstract class Parser[+T] extends (Input) ⇒ ParseResult[T]

Definition Classes
Parsers
case class Success[+T] extends ParseResult[T] with Product with Serializable

Definition Classes
Parsers
case class ~[+a, +b] extends Product with Serializable

Definition Classes
Parsers

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from DocParser to any2stringadd[DocParser] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (DocParser, B)

Implicit information
This member is added by an implicit conversion from DocParser to ArrowAssoc[DocParser] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object NoSuccess

Definition Classes
Parsers
def OnceParser[T](f: (Input) ⇒ ParseResult[T]): Parser[T] with OnceParser[T]

Definition Classes
Parsers
def Parser[T](f: (Input) ⇒ ParseResult[T]): Parser[T]

Definition Classes
Parsers
def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

Definition Classes
Parsers
def accept[ES](es: ES)(implicit f: (ES) ⇒ List[Elem]): Parser[List[Elem]]

Definition Classes
Parsers
implicit def accept(e: Elem): Parser[Elem]

Definition Classes
Parsers
def acceptIf(p: (Elem) ⇒ Boolean)(err: (Elem) ⇒ String): Parser[Elem]

Definition Classes
Parsers
def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

Definition Classes
Parsers
def acceptSeq[ES](es: ES)(implicit f: (ES) ⇒ Iterable[Elem]): Parser[List[Elem]]

Definition Classes
Parsers
final def asInstanceOf[T0]: T0

Definition Classes
Any
def chainl1[T, U](first: ⇒ Parser[T], p: ⇒ Parser[U], q: ⇒ Parser[(T, U) ⇒ T]): Parser[T]

Definition Classes
Parsers
def chainl1[T](p: ⇒ Parser[T], q: ⇒ Parser[(T, T) ⇒ T]): Parser[T]

Definition Classes
Parsers
def chainr1[T, U](p: ⇒ Parser[T], q: ⇒ Parser[(T, U) ⇒ U], combine: (T, U) ⇒ U, first: U): Parser[U]

Definition Classes
Parsers
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def commit[T](p: ⇒ Parser[T]): Parser[T]

Definition Classes
Parsers
def docString: Parser[DocString]

Attributes
protected
def docs: Parser[Docs]
def elem(e: Elem): Parser[Elem]

Definition Classes
Parsers
def elem(kind: String, p: (Elem) ⇒ Boolean): Parser[Elem]

Definition Classes
Parsers
val enableProfiling: Boolean

Attributes
protected
Definition Classes
DocParser → BaseParser
def ensuring(cond: (DocParser) ⇒ Boolean, msg: ⇒ Any): DocParser

Implicit information
This member is added by an implicit conversion from DocParser to Ensuring[DocParser] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (DocParser) ⇒ Boolean): DocParser

Implicit information
This member is added by an implicit conversion from DocParser to Ensuring[DocParser] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): DocParser

Implicit information
This member is added by an implicit conversion from DocParser to Ensuring[DocParser] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): DocParser

Implicit information
This member is added by an implicit conversion from DocParser to Ensuring[DocParser] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def err(msg: String): Parser[Nothing]

Definition Classes
Parsers
def failure(msg: String): Parser[Nothing]

Definition Classes
Parsers
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from DocParser to StringFormat[DocParser] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def getResult[T](res: ParseResult[T]): T

Attributes
protected
Definition Classes
BaseParser
def guard[T](p: ⇒ Parser[T]): Parser[T]

Definition Classes
Parsers
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def log: Logger

Attributes
protected
Definition Classes
Logger
def log[T](p: ⇒ Parser[T])(name: String): Parser[T]

Definition Classes
Parsers
val logger: Logger

Attributes
protected
Definition Classes
Logging
def loggingTime[A](tag: String)(f: ⇒ A): A

Attributes
protected
Definition Classes
Logger
def loggingTimeMuted[A](tag: String)(f: ⇒ A): A

Attributes
protected
Definition Classes
Logger
def mkList[T]: (~[T, List[T]]) ⇒ List[T]

Definition Classes
Parsers
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def not[T](p: ⇒ Parser[T]): Parser[Unit]

Definition Classes
Parsers
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def opt[T](p: ⇒ Parser[T]): Parser[Option[T]]

Definition Classes
Parsers
def parse[T](parser: Parser[T], input: CharSequence, sourceName: String): T

Attributes
protected
def parse(input: CharSequence, sourceName: String): Docs
def phrase[T](p: Parser[T]): Parser[T]

Definition Classes
Parsers
def positioned[T <: Positional](p: ⇒ Parser[T]): Parser[T]

Definition Classes
Parsers
def profile[T](name: String)(p: Parser[T]): Parser[T]

Attributes
protected
Definition Classes
BaseParser
def reference: Parser[DocReference]

Attributes
protected
def rep[T](p: ⇒ Parser[T]): Parser[List[T]]

Definition Classes
Parsers
def rep1[T](first: ⇒ Parser[T], p0: ⇒ Parser[T]): Parser[List[T]]

Definition Classes
Parsers
Annotations
@migration
Migration
(Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
def rep1[T](p: ⇒ Parser[T]): Parser[List[T]]

Definition Classes
Parsers
def rep1sep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

Definition Classes
Parsers
def repN[T](num: Int, p: ⇒ Parser[T]): Parser[List[T]]

Definition Classes
Parsers
def repsep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

Definition Classes
Parsers
def success[T](v: T): Parser[T]

Definition Classes
Parsers
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def tryParse[T](parser: Parser[T], input: CharSequence, sourceName: String): ParseResult[T]

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (DocParser, B)

Implicit information
This member is added by an implicit conversion from DocParser to ArrowAssoc[DocParser] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Inherited from BaseParser

Inherited from Logger

Inherited from Logging

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DocParser to any2stringadd[DocParser]

Inherited by implicit conversion StringFormat from DocParser to StringFormat[DocParser]

Inherited by implicit conversion Ensuring from DocParser to Ensuring[DocParser]

Inherited by implicit conversion ArrowAssoc from DocParser to ArrowAssoc[DocParser]

Ungrouped

Related Doc: package doc

class DocParser extends BaseParser

Instance Constructors

new DocParser(enableProfiling: Boolean = false)

Type Members

type Elem = DocLexer.Token

case class Error extends NoSuccess with Product with Serializable

case class Failure extends NoSuccess with Product with Serializable

type Input = Reader[Elem]

sealed abstract class NoSuccess extends ParseResult[Nothing]

trait OnceParser[+T] extends Parser[T]

sealed abstract class ParseResult[+T] extends AnyRef

abstract class Parser[+T] extends (Input) ⇒ ParseResult[T]

case class Success[+T] extends ParseResult[T] with Product with Serializable

case class ~[+a, +b] extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (DocParser, B)

final def ==(arg0: Any): Boolean

object NoSuccess

def OnceParser[T](f: (Input) ⇒ ParseResult[T]): Parser[T] with OnceParser[T]

def Parser[T](f: (Input) ⇒ ParseResult[T]): Parser[T]

def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

def accept[ES](es: ES)(implicit f: (ES) ⇒ List[Elem]): Parser[List[Elem]]

implicit def accept(e: Elem): Parser[Elem]

def acceptIf(p: (Elem) ⇒ Boolean)(err: (Elem) ⇒ String): Parser[Elem]

def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

def acceptSeq[ES](es: ES)(implicit f: (ES) ⇒ Iterable[Elem]): Parser[List[Elem]]

final def asInstanceOf[T0]: T0

def chainl1[T, U](first: ⇒ Parser[T], p: ⇒ Parser[U], q: ⇒ Parser[(T, U) ⇒ T]): Parser[T]

def chainl1[T](p: ⇒ Parser[T], q: ⇒ Parser[(T, T) ⇒ T]): Parser[T]

def chainr1[T, U](p: ⇒ Parser[T], q: ⇒ Parser[(T, U) ⇒ U], combine: (T, U) ⇒ U, first: U): Parser[U]

def clone(): AnyRef

def commit[T](p: ⇒ Parser[T]): Parser[T]

def docString: Parser[DocString]

def docs: Parser[Docs]

def elem(e: Elem): Parser[Elem]

def elem(kind: String, p: (Elem) ⇒ Boolean): Parser[Elem]

val enableProfiling: Boolean

def ensuring(cond: (DocParser) ⇒ Boolean, msg: ⇒ Any): DocParser

def ensuring(cond: (DocParser) ⇒ Boolean): DocParser

def ensuring(cond: Boolean, msg: ⇒ Any): DocParser

def ensuring(cond: Boolean): DocParser

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def err(msg: String): Parser[Nothing]

def failure(msg: String): Parser[Nothing]

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def getResult[T](res: ParseResult[T]): T

def guard[T](p: ⇒ Parser[T]): Parser[T]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def log: Logger

def log[T](p: ⇒ Parser[T])(name: String): Parser[T]

val logger: Logger

def loggingTime[A](tag: String)(f: ⇒ A): A

def loggingTimeMuted[A](tag: String)(f: ⇒ A): A

def mkList[T]: (~[T, List[T]]) ⇒ List[T]

final def ne(arg0: AnyRef): Boolean

def not[T](p: ⇒ Parser[T]): Parser[Unit]

final def notify(): Unit

final def notifyAll(): Unit

def opt[T](p: ⇒ Parser[T]): Parser[Option[T]]

def parse[T](parser: Parser[T], input: CharSequence, sourceName: String): T

def parse(input: CharSequence, sourceName: String): Docs

def phrase[T](p: Parser[T]): Parser[T]

def positioned[T <: Positional](p: ⇒ Parser[T]): Parser[T]

def profile[T](name: String)(p: Parser[T]): Parser[T]

def reference: Parser[DocReference]

def rep[T](p: ⇒ Parser[T]): Parser[List[T]]

def rep1[T](first: ⇒ Parser[T], p0: ⇒ Parser[T]): Parser[List[T]]

def rep1[T](p: ⇒ Parser[T]): Parser[List[T]]

def rep1sep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

def repN[T](num: Int, p: ⇒ Parser[T]): Parser[List[T]]

def repsep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

def success[T](v: T): Parser[T]