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
  • package json

    This package provides extensions to the core "spac" library which allow for the handling of JSON data.

    This package provides extensions to the core "spac" library which allow for the handling of JSON data.

    Rather than creating explicit classes that extend Parser, Transformer, and Splitter, this package provides type aliases and implicit extensions. For example, JsonParser[A] is just a type alias for Parser[JsonEvent, A], and JsonParser is just a call to Parser[JsonEvent].

    Implicit JsonParsers are available for each of the JSON primitive types:

    • string
    • number (expressed as Int, Long, Float, or Double)
    • boolean
    • null (expressed as None.type)

    Helpers are available for parsing JSON arrays and objects:

    • JsonParser.listOf[A] to parse an array where each value is an A
    • JsonParser.objectOf[A] to parse an object where the value for each field an A
    • JsonParser.objectOfNullable[A] to parse an object where the value for each field is either null or an A, filtering out the nulls
    • JsonParser.fieldOf[A](fieldName) to parse a specific field from an object

    A DSL for creating json-specific ContextMatchers is provided to make it more convenient to call Splitter.json. For example:

    Splitter.json("foo" \ "bar").as[String].parseFirst

    Can be used to capture rootJson.foo.bar as a String in

    {
      "foo": {
        "bar": "hello"
      }
    }

    To "split" values inside arrays, index-related context matchers are available, e.g.

    Splitter.json("foo" \ anyIndex).as[Int].parseToList

    Can be used to capture each of the numbers in the "foo" array in

    {
      "foo": [1, 2, 3]
    }

    A note about JsonEvents in spac: JSON doesn't have any explicit markers for when a field ends, or when an array index starts or ends; those context changes are essentially inferred by the presence of some other event. For example, instead of a "field end" event, typically there will be either a new "field start" or a token representing the end of the current object. With spac, splitters and context matchers generally operate under the assumption that a "stack push" event (like a field start) will eventually be followed by a corresponding "stack pop" event (i.e. field end).

    To allow for this, these "inferred" events (FieldEnd, IndexStart, IndexEnd) are explicitly represented as JsonEvents in the stream being parsed. Keep this in mind when creating JSON ContextMatchers:

    • field-related matchers will match a stack like case ObjectStart :: FieldStart(_) :: _
    • index-related matchers will match a stack like case ArrayStart :: IndexStart(_) :: _
    Definition Classes
    spac
  • object JsonEvent

    Definition Classes
    json
  • ArrayEnd
  • ArrayStart
  • FieldEnd
  • FieldStart
  • IndexEnd
  • IndexStart
  • JBool
  • JDouble
  • JLong
  • JNull
  • JString
  • ObjectEnd
  • ObjectStart

trait FieldStart extends JsonStackElem

Source
JsonEvent.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldStart
  2. JsonStackElem
  3. JsonEvent
  4. HasLocation
  5. AnyRef
  6. 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

Abstract Value Members

  1. abstract def fieldName: String
  2. abstract def location: ContextLocation
    Definition Classes
    HasLocation

Concrete 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 FieldStart toany2stringadd[FieldStart] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FieldStart, B)
    Implicit
    This member is added by an implicit conversion from FieldStart toArrowAssoc[FieldStart] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def asBool: Option[JBool]
    Definition Classes
    JsonEvent
  7. def asDouble: Option[JDouble]
    Definition Classes
    JsonEvent
  8. def asFieldEnd: Option[FieldEnd]
    Definition Classes
    JsonEvent
  9. def asFieldStart: Some[FieldStart]
    Definition Classes
    FieldStartJsonEvent
  10. def asIndexEnd: Option[IndexEnd]
    Definition Classes
    JsonEvent
  11. def asIndexStart: Option[IndexStart]
    Definition Classes
    JsonEvent
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def asLong: Option[JLong]
    Definition Classes
    JsonEvent
  14. def asNull: Option[JNull]
    Definition Classes
    JsonEvent
  15. def asStackPop: Option[JsonStackPop]
    Definition Classes
    JsonEvent
  16. def asStackPush: Some[JsonStackElem]
    Definition Classes
    JsonStackElemJsonEvent
  17. def asString: Option[JString]
    Definition Classes
    JsonEvent
  18. def asValueEvent: Option[JsonValueEvent]
    Definition Classes
    JsonEvent
  19. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  20. def ensuring(cond: (FieldStart) => Boolean, msg: => Any): FieldStart
    Implicit
    This member is added by an implicit conversion from FieldStart toEnsuring[FieldStart] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. def ensuring(cond: (FieldStart) => Boolean): FieldStart
    Implicit
    This member is added by an implicit conversion from FieldStart toEnsuring[FieldStart] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: Boolean, msg: => Any): FieldStart
    Implicit
    This member is added by an implicit conversion from FieldStart toEnsuring[FieldStart] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean): FieldStart
    Implicit
    This member is added by an implicit conversion from FieldStart toEnsuring[FieldStart] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  27. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FieldStart toStringFormat[FieldStart] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def isArrayEnd: Boolean
    Definition Classes
    JsonEvent
  31. def isArrayStart: Boolean
    Definition Classes
    JsonEvent
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isObjectEnd: Boolean
    Definition Classes
    JsonEvent
  34. def isObjectStart: Boolean
    Definition Classes
    JsonEvent
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def showRawJson: String
    Definition Classes
    FieldStartJsonEvent
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. def toString(): String
    Definition Classes
    FieldStart → AnyRef → Any
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (FieldStart, B)
    Implicit
    This member is added by an implicit conversion from FieldStart toArrowAssoc[FieldStart] 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 JsonStackElem

Inherited from JsonEvent

Inherited from HasLocation

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFieldStart to any2stringadd[FieldStart]

Inherited by implicit conversion StringFormat fromFieldStart to StringFormat[FieldStart]

Inherited by implicit conversion Ensuring fromFieldStart to Ensuring[FieldStart]

Inherited by implicit conversion ArrowAssoc fromFieldStart to ArrowAssoc[FieldStart]

Ungrouped