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
c

io.dylemma.spac.Parser

ParserFollowedByOps

implicit class ParserFollowedByOps[In, A] extends AnyRef

Adds followedBy and followedByStream to Parser (they aren't defined in the Parser trait due to the In type needing to be invariant here)

Source
Parser.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ParserFollowedByOps
  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. All

Instance Constructors

  1. new ParserFollowedByOps(parser: Parser[In, A])

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 ParserFollowedByOps[In, A] toany2stringadd[ParserFollowedByOps[In, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ParserFollowedByOps[In, A], B)
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toArrowAssoc[ParserFollowedByOps[In, 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: (ParserFollowedByOps[In, A]) => Boolean, msg: => Any): ParserFollowedByOps[In, A]
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toEnsuring[ParserFollowedByOps[In, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ParserFollowedByOps[In, A]) => Boolean): ParserFollowedByOps[In, A]
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toEnsuring[ParserFollowedByOps[In, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ParserFollowedByOps[In, A]
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toEnsuring[ParserFollowedByOps[In, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ParserFollowedByOps[In, A]
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toEnsuring[ParserFollowedByOps[In, A]] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def followedBy: FollowedBy[In, A, Parser]

    Intermediate object for creating a sequenced parser in which the result of this parser will be used to initialize a second parser as soon as it is available.

    Intermediate object for creating a sequenced parser in which the result of this parser will be used to initialize a second parser as soon as it is available.

    In other words, the source (series of In values) will be fed into this Parser until this parser's handler returns a result of type Out. At that point, the second parser (as specified by using the apply or flatMap methods on the FollowedBy returned by this method) will be instantiated. Any relevant "stack events" (see Stackable) will be replayed so the second parser has the right context, and from that point on, all In values will be sent to the second parser. When that second parser returns a result, that result becomes the output of the combined parser created by this.followedBy(out => makeSecondParser(out))

    Examples:

    val p1: Parser[A] = /* ... */
    def getP2(p1Result: A): Parser[B] = /* ... */
    val combined: Parser[B] = p1.followedBy(getP2)
    
    // alternative `flatMap` syntax
    val combined: Parser[B] = for {
      p1Result <- p1.followedBy
      p2Result <- getP2(p1Result)
    } yield p2Result

    See Parser's interruptedBy, which is useful when a transformer.parseFirstOption must be followedBy some other parser.

  16. def followedByParser: FollowedBy[In, A, Parser]

    Alias for followedBy, for use when Cat's ApplyOps gets in the way with its own useless followedBy method.

  17. def followedByStream: FollowedBy[In, A, Transformer]

    Intermediate object creating a transformer that depends on this parser.

    Intermediate object creating a transformer that depends on this parser. Particularly useful in cases where one or more specific "info" elements precede a stream of other elements which require that "info" to be parsed.

    Examples:

    val p1: Parser[In, A] = /* ... */
    def getP2Stream(p1Result: A): Transformer[In, B] = /* ... */
    val combined: Transformer[In, B] = p1.andThenStream(getP2Stream)
    
    // alternative `flatMap` syntax
    val combined: Transformer[In, B] = for {
      p1Result <- p1.andThenStream
      p2Result <- getP2Stream(p1Result)
    } yield p2Result

    See followedBy for a general explanation of how the combination works.

    See also, interruptedBy, which is useful when a transformer.parseFirstOption must be followedBy some other transformer.

  18. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toStringFormat[ParserFollowedByOps[In, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  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): (ParserFollowedByOps[In, A], B)
    Implicit
    This member is added by an implicit conversion from ParserFollowedByOps[In, A] toArrowAssoc[ParserFollowedByOps[In, 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromParserFollowedByOps[In, A] to any2stringadd[ParserFollowedByOps[In, A]]

Inherited by implicit conversion StringFormat fromParserFollowedByOps[In, A] to StringFormat[ParserFollowedByOps[In, A]]

Inherited by implicit conversion Ensuring fromParserFollowedByOps[In, A] to Ensuring[ParserFollowedByOps[In, A]]

Inherited by implicit conversion ArrowAssoc fromParserFollowedByOps[In, A] to ArrowAssoc[ParserFollowedByOps[In, A]]

combinators

Ungrouped