Class

laika.parse

Failure

Related Doc: package parse

Permalink

case class Failure(msgProvider: Message, next: ParserContext) extends Parsed[Nothing] with Product with Serializable

The failure case of Parsed containing an error message and the remaining input.

Implementation note: The message property is of type Message, to allow for lazy message creation. The former SDK parser combinators which this API is partially inspired by contained a lot of unnecessary string concatenations for messages which were then never read. This implementation avoids this extra cost and the result is measurable (about 15% performance gain for a typical Markdown document for example).

msgProvider

A provider that produces an error message for this failure based on its ParserContext

next

The parser's unconsumed input at the point where the failure occurred.

Linear Supertypes
Serializable, Serializable, Product, Equals, Parsed[Nothing], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Failure
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Parsed
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Failure(msgProvider: Message, next: ParserContext)

    Permalink

    msgProvider

    A provider that produces an error message for this failure based on its ParserContext

    next

    The parser's unconsumed input at the point where the failure occurred.

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. def get: Nothing

    Permalink

    The result value from the parser invocation.

    The result value from the parser invocation. This method will throw on instances where isSuccess returns false.

    Definition Classes
    FailureParsed
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getOrElse[B >: Nothing](default: ⇒ B): B

    Permalink

    Returns the result value from the parser invocation if the parser succeeded or otherwise the specified fallback value.

    Returns the result value from the parser invocation if the parser succeeded or otherwise the specified fallback value.

    Definition Classes
    Parsed
  11. def isFailure: Boolean

    Permalink

    Indicates whether this results represents an unsuccessful parser invocation.

    Indicates whether this results represents an unsuccessful parser invocation. The get method will throw on instances where this method returns true.

    Definition Classes
    Parsed
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val isSuccess: Boolean

    Permalink

    Indicates whether this results represents a successful parser invocation.

    Indicates whether this results represents a successful parser invocation. The get method will throw on instances where this method returns false.

    Definition Classes
    FailureParsed
  14. def map[U](f: (Nothing) ⇒ U): Failure

    Permalink

    Builds a new Parsed instance by applying the specified function to the result of this instance.

    Builds a new Parsed instance by applying the specified function to the result of this instance.

    Definition Classes
    FailureParsed
  15. lazy val message: String

    Permalink

    The message specifying the cause of the failure.

  16. val msgProvider: Message

    Permalink

    A provider that produces an error message for this failure based on its ParserContext

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. val next: ParserContext

    Permalink

    The parser's unconsumed input at the point where the failure occurred.

    The parser's unconsumed input at the point where the failure occurred.

    Definition Classes
    FailureParsed
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def orElse[U >: Nothing](default: ⇒ Parsed[U]): Parsed[U]

    Permalink

    Returns this Parsed instance if the parser suceeded or otherwise the specified fallback instance.

    Returns this Parsed instance if the parser suceeded or otherwise the specified fallback instance.

    Definition Classes
    Parsed
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    Failure → AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Parsed[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped