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 Parser

    Definition Classes
    spac
  • FollowedBy
  • Handler
  • ParserFlatten
  • ParserFollowedByOps
  • Stateless

trait FollowedBy[In, +A, M[-_, +_]] extends AnyRef

An intermediate object for creating sequence-based combination methods for a Parser or Consumer.

A

Output type for the "first" parser/consumer; using the combination methods in this trait will result in an instance of T1 being used to create a "second" parser/consumer/transformer to be run sequentially after the first.

M

Type constructor for the parser/consumer of a given output type

Self Type
FollowedBy[In, A, M]
Source
Parser.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FollowedBy
  2. AnyRef
  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. Protected

Abstract Value Members

  1. abstract def apply[Out](followUp: (A) => M[In, Out])(implicit S: StackLike[In, Any]): M[In, Out]

    Creates a sequence handler by combining this one and a getNext function such that when this handler finishes, a second handler is created by passing its result ot getNext.

    Creates a sequence handler by combining this one and a getNext function such that when this handler finishes, a second handler is created by passing its result ot getNext.

    followUp

    A function that creates the new Parser/Transformer (whichever M is in this context) based on the result of this parser

    returns

    The combined parser/transformer

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 FollowedBy[In, A, M] toany2stringadd[FollowedBy[In, A, M]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FollowedBy[In, A, M], B)
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toArrowAssoc[FollowedBy[In, A, M]] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (FollowedBy[In, A, M]) => Boolean, msg: => Any): FollowedBy[In, A, M]
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toEnsuring[FollowedBy[In, A, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (FollowedBy[In, A, M]) => Boolean): FollowedBy[In, A, M]
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toEnsuring[FollowedBy[In, A, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): FollowedBy[In, A, M]
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toEnsuring[FollowedBy[In, A, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): FollowedBy[In, A, M]
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toEnsuring[FollowedBy[In, A, M]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def flatMap[Out](followUp: (A) => M[In, Out])(implicit S: StackLike[In, Any]): M[In, Out]

    Alias for apply, allowing the use of for-comprehension syntax, e.g.

    Alias for apply, allowing the use of for-comprehension syntax, e.g.

    for {
  a <- someParser
  result <- getNextParser(a)
} yield result
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def map[B](f: (A) => B)(implicit S: StackLike[In, Any]): FollowedBy[In, B, M]

    Transforms the intermediate result that will be passed to the followUp function.

    Transforms the intermediate result that will be passed to the followUp function. Really this method is only here to allow for-comprehension syntax to be used - see flatMap. You probably don't want to call this explicitly.

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toStringFormat[FollowedBy[In, A, M]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def →[B](y: B): (FollowedBy[In, A, M], B)
    Implicit
    This member is added by an implicit conversion from FollowedBy[In, A, M] toArrowAssoc[FollowedBy[In, A, M]] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromFollowedBy[In, A, M] to any2stringadd[FollowedBy[In, A, M]]

Inherited by implicit conversion StringFormat fromFollowedBy[In, A, M] to StringFormat[FollowedBy[In, A, M]]

Inherited by implicit conversion Ensuring fromFollowedBy[In, A, M] to Ensuring[FollowedBy[In, A, M]]

Inherited by implicit conversion ArrowAssoc fromFollowedBy[In, A, M] to ArrowAssoc[FollowedBy[In, A, M]]

Ungrouped