Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package dylemma
    Definition Classes
    io
  • package spac

    SPaC (short for "Streaming Parser Combinators") is a library for building stream consumers in a declarative style, specialized for tree-like data types like XML and JSON.

    SPaC (short for "Streaming Parser Combinators") is a library for building stream consumers in a declarative style, specialized for tree-like data types like XML and JSON.

    Many utilities for handling XML and JSON data involve parsing the entire "document" to some DOM model, then inspecting and transforming that model to extract information. The downside to these utilities is that when the document is very large, the DOM may not fit in memory. The workaround for this type of problem is to treat the document as a stream of "events", e.g. "StartElement" and "EndElement" for XML, or "StartObject" and "EndObject" for JSON. The downside to this workaround is that writing code to handle these streams can be complicated and error-prone, especially when the DOM is complicated.

    SPaC's goal is to drastically simplify the process of creating code to handle these streams.

    This package contains the "core" SPaC traits; Parser, Transformer, Splitter, and ContextMatcher.

    See the xml and json subpackages (provided by the xml-spac and json-spac libraries respectively) for specific utilities related to handling XML and JSON event streams.

    Definition Classes
    dylemma
  • object SpacTraceElement

    Definition Classes
    spac
  • AtInputEnd
  • InCompound
  • InInput
  • InInputContext
  • InParse
  • InSplitter
  • NearLocation

case class InInputContext[A](input: A, location: ContextLocation) extends SpacTraceElement with Product with Serializable

Used when ContextMatcher-based splitters are involved, appearing in the middle of a SpacException's spacTrace. Similar to InInput, but generally represents a previous input which was interpreted as a "stack push". For example, an XML start-element event would indicate "the error is somewhere within this element"

Source
SpacTraceElement.scala
Linear Supertypes
Serializable, Product, Equals, SpacTraceElement, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InInputContext
  2. Serializable
  3. Product
  4. Equals
  5. SpacTraceElement
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new InInputContext(input: A, location: ContextLocation)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toany2stringadd[InInputContext[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InInputContext[A], B)
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toArrowAssoc[InInputContext[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (InInputContext[A]) => Boolean, msg: => Any): InInputContext[A]
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toEnsuring[InInputContext[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (InInputContext[A]) => Boolean): InInputContext[A]
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toEnsuring[InInputContext[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): InInputContext[A]
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toEnsuring[InInputContext[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): InInputContext[A]
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toEnsuring[InInputContext[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toStringFormat[InInputContext[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. val input: A
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val location: ContextLocation
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. def render: String

    Create a String that somewhat resembles a StackTraceElement, without actually conforming to StackTraceElement's toString.

    Create a String that somewhat resembles a StackTraceElement, without actually conforming to StackTraceElement's toString.

    Definition Classes
    InInputContext → SpacTraceElement
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toStackTraceElement: StackTraceElement

    Create a StackTraceElement, abusing the className/methodName/fileName arguments such that the created StackTraceElement's toString returns something similar to the render method.

    Create a StackTraceElement, abusing the className/methodName/fileName arguments such that the created StackTraceElement's toString returns something similar to the render method.

    The general pattern is that SpacTraceElements that include CallerPos arguments will use either parser or client as the "className" and provide a real fileName and line number. Input-related events will use "input" as the "className" and "data source" as the fileName.

    returns

    A StackTraceElement that resembles this SpacTraceElement's render output

    Definition Classes
    InInputContext → SpacTraceElement
  26. def truncateNote(note: String, maxLen: Int = 100): String
    Attributes
    protected
    Definition Classes
    SpacTraceElement
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (InInputContext[A], B)
    Implicit
    This member is added by an implicit conversion from InInputContext[A] toArrowAssoc[InInputContext[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SpacTraceElement

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromInInputContext[A] to any2stringadd[InInputContext[A]]

Inherited by implicit conversion StringFormat fromInInputContext[A] to StringFormat[InInputContext[A]]

Inherited by implicit conversion Ensuring fromInInputContext[A] to Ensuring[InInputContext[A]]

Inherited by implicit conversion ArrowAssoc fromInInputContext[A] to ArrowAssoc[InInputContext[A]]

Ungrouped