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
  • Fs2DataSource
  • JacksonSource
  • JsonEvent
  • JsonParserApplyOps
  • JsonSplitterApplyOps
  • JsonSplitterOps
  • JsonStackElem
  • JsonStackPop
  • JsonValueEvent
c

io.dylemma.spac.json

JsonSplitterApplyOps

implicit final class JsonSplitterApplyOps extends AnyVal

Adds Splitter.json, for constructing json context matcher-based JsonSplitters

Source
package.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSplitterApplyOps
  2. AnyVal
  3. 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 JsonSplitterApplyOps(splitter: Splitter.type)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toany2stringadd[JsonSplitterApplyOps] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JsonSplitterApplyOps, B)
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toArrowAssoc[JsonSplitterApplyOps] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def ensuring(cond: (JsonSplitterApplyOps) => Boolean, msg: => Any): JsonSplitterApplyOps
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toEnsuring[JsonSplitterApplyOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (JsonSplitterApplyOps) => Boolean): JsonSplitterApplyOps
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toEnsuring[JsonSplitterApplyOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): JsonSplitterApplyOps
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toEnsuring[JsonSplitterApplyOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): JsonSplitterApplyOps
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toEnsuring[JsonSplitterApplyOps] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from JsonSplitterApplyOps toStringFormat[JsonSplitterApplyOps] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  12. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def json[C](matcher: ContextMatcher[JsonStackElem, C])(implicit pos: CallerPos): JsonSplitter[C]

    Create a Splitter for JsonEvents using the given matcher to determine where sub-streams start and end.

    Create a Splitter for JsonEvents using the given matcher to determine where sub-streams start and end. For example, Splitter.json("foo"), when applied to the json:

    {
      "foo": [1, 2],
      "bar": true
    }

    would identify the value of the object's "foo" field as a sub-stream of JsonEvents, containing the events ArrayStart, IndexStart(0), JLong(1), IndexEnd, IndexStart(1), JLong(2), IndexEnd, ArrayEnd.

    Any context matched by the matcher will be passed through the joiner functions if you call as, map, or flatMap on the resulting splitter, and thus the matched context can be used to decide how you parse each sub-stream.

    C

    The type of the "context" matched by the matcher

    matcher

    A ContextMatcher used to identify where each sub-stream begins and ends, and extracts some context value to identify each sub-stream.

    pos

    Used to construct a SpacFrameElement if a parser constructed from this splitter fails

    returns

    A new JsonSplitter that will split a stream into sub-streams identified by the matcher

  15. def toString(): String
    Definition Classes
    Any

Deprecated Value Members

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

Inherited from Any

Inherited by implicit conversion any2stringadd fromJsonSplitterApplyOps to any2stringadd[JsonSplitterApplyOps]

Inherited by implicit conversion StringFormat fromJsonSplitterApplyOps to StringFormat[JsonSplitterApplyOps]

Inherited by implicit conversion Ensuring fromJsonSplitterApplyOps to Ensuring[JsonSplitterApplyOps]

Inherited by implicit conversion ArrowAssoc fromJsonSplitterApplyOps to ArrowAssoc[JsonSplitterApplyOps]

Ungrouped