Packages

case class Failure(msgProvider: Message, next: SourceCursor, maxOffset: Int) 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 SourceCursor

next

The unconsumed input at the point where the failing parser started

maxOffset

The offset position the parser could successfully read to before failing

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: SourceCursor, maxOffset: Int)

    msgProvider

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

    next

    The unconsumed input at the point where the failing parser started

    maxOffset

    The offset position the parser could successfully read to before failing

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  8. def getOrElse[B >: Nothing](default: ⇒ B): B

    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
  9. def isFailure: Boolean

    Indicates whether this results represents an unsuccessful parser invocation.

    Indicates whether this results represents an unsuccessful parser invocation.

    Definition Classes
    Parsed
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val isSuccess: Boolean

    Indicates whether this results represents a successful parser invocation.

    Indicates whether this results represents a successful parser invocation.

    Definition Classes
    Failure → Parsed
  12. def map[U](f: (Nothing) ⇒ U): Failure

    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
    Failure → Parsed
  13. val maxOffset: Int
  14. lazy val message: String

    The message specifying the cause of the failure.

  15. val msgProvider: Message
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val next: SourceCursor

    The context representing the remaining input left over by the parser that produced this result.

    The context representing the remaining input left over by the parser that produced this result.

    Definition Classes
    Failure → Parsed
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def orElse[U](default: ⇒ Parsed[U]): Parsed[U]

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

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

    Definition Classes
    Failure → Parsed
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toEither: Either[String, Nothing]

    The result as an Either, a Left in case of failure.

    The result as an Either, a Left in case of failure.

    Definition Classes
    Failure → Parsed
  23. def toOption: Option[Nothing]

    The result as an Option, empty in case of failure.

    The result as an Option, empty in case of failure.

    Definition Classes
    Failure → Parsed
  24. def toString(): String
    Definition Classes
    Failure → AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Parsed[Nothing]

Inherited from AnyRef

Inherited from Any

Ungrouped