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 ContextMatcher

    Definition Classes
    spac
  • Chained
  • Mapped
  • Or

case class Or[Elem, A](left: ContextMatcher[Elem, A], right: ContextMatcher[Elem, A]) extends ContextMatcher[Elem, A] with Product with Serializable

Matcher implementation for left | right.

A

The type of the matched context.

left

The left matcher (i.e. the first choice)

right

The right matcher (i.e. the fallback)

Source
ContextMatcher.scala
Linear Supertypes
Serializable, Product, Equals, ContextMatcher[Elem, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Or
  2. Serializable
  3. Product
  4. Equals
  5. ContextMatcher
  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. Protected

Instance Constructors

  1. new Or(left: ContextMatcher[Elem, A], right: ContextMatcher[Elem, A])

    left

    The left matcher (i.e. the first choice)

    right

    The right matcher (i.e. the fallback)

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 Or[Elem, A] toany2stringadd[Or[Elem, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Or[Elem, A], B)
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toArrowAssoc[Or[Elem, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def \[A1 >: A, B, R](next: ContextMatcher[Elem, B])(implicit reduce: Aux[A1, B, R]): ContextMatcher[Elem, R]

    Create a new matcher by forming a chain with this matcher at the front, and the next matcher at the back.

    Create a new matcher by forming a chain with this matcher at the front, and the next matcher at the back. In other words, a matcher for a context within another context.

    A1

    To satisfy covariance on A

    B

    The next matcher's context type

    R

    The "reduced" content type, derived from the tuple type (A, B) based on the reduce rule.

    next

    A matcher which will be used to match the "inner" context

    reduce

    The TypeReduce rule to help omit Unit from the resulting context type

    returns

    A matcher which delegates to this matcher first, then the next matcher for the remaining stack.

    Definition Classes
    ContextMatcher
  7. def apply(stack: IndexedSeq[Elem], offset: Int, avail: Int): Option[A]

    The main context match method.

    The main context match method.

    Inspects the elements in the XML "tag stack", which is essentially a List[StartElement], but for performance reasons is represented as an array with an "offset" index and a number of available elements from that offset. If the elements correspond to a context value of A, the implementation must then pass the remaining elements of the stack to the next matcher, i.e. by calling next(stack, offset + numConsumed, avail - numConsumed).

    The difference between this method and applyChained is the lack of the next parameter; in this method, the current matcher is assumed to be the end of the chain.

    stack

    A reference to the complete XML "tag stack". Note that the responsibility of this method is limited to a *slice* of this value, as defined by offset and avail.

    offset

    The index of the first element to be considered by the matching logic. From this method's point of view, the "first" element in the stack is actually at stack(offset)

    avail

    The number of elements available in the stack starting from the offset.

    returns

    An option containing the successfully-matched context, or None.

    Definition Classes
    ContextMatcher
  8. def applyChained[B](stack: IndexedSeq[Elem], offset: Int, avail: Int, next: ContextMatcher[Elem, B]): Option[(A, B)]

    The underlying context match method.

    The underlying context match method.

    Inspects the elements in the XML "tag stack", which is essentially a List[StartElement], but for performance reasons is represented as an array with an "offset" index and a number of available elements from that offset. If the elements correspond to a context value of A, the implementation must then pass the remaining elements of the stack to the next matcher, i.e. by calling next(stack, offset + numConsumed, avail - numConsumed).

    The next matcher is necessary in order to support non-greedy matchers, e.g. ContextMatcher.variableLength, a.k.a. **. Without a reference to the next matcher in the chain, matcher implementations would be forced to pick a fixed number of elements for matching, never knowing that the overall match could have succeeded if they had consumed some additional elements.

    B

    The next matcher's context type

    stack

    A reference to the complete XML "tag stack". Note that the responsibility of this method is limited to a *slice* of this value, as defined by offset and avail.

    offset

    The index of the first element to be considered by the matching logic. From this method's point of view, the "first" element in the stack is actually at stack(offset)

    avail

    The number of elements available in the stack starting from the offset.

    next

    The next matcher in the chain.

    returns

    If the match succeeded, and the next match succeded, an Option containing a tuple of both match results. If the match failed, or if the next match failed, None.

    Definition Classes
    OrContextMatcher
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def ensuring(cond: (Or[Elem, A]) => Boolean, msg: => Any): Or[Elem, A]
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toEnsuring[Or[Elem, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Or[Elem, A]) => Boolean): Or[Elem, A]
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toEnsuring[Or[Elem, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Or[Elem, A]
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toEnsuring[Or[Elem, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Or[Elem, A]
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toEnsuring[Or[Elem, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def filter(p: (A) => Boolean): ContextMatcher[Elem, A]

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the validation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the validation function f. If f returns false, the match is unsuccessful.

    p

    The filter predicate, i.e. the validation function

    returns

    A new matcher with validated results

    Definition Classes
    ContextMatcher
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  18. def flatMap[B](f: (A) => Option[B]): ContextMatcher[Elem, B]

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the combined transformation/validation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the combined transformation/validation function f. If f returns None, the match is unsuccessful; if f returns a Some, the value inside is the result of the match.

    B

    The transformed context type

    f

    The transformation/validation function

    returns

    A new matcher with transformed and validated results

    Definition Classes
    ContextMatcher
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val left: ContextMatcher[Elem, A]
  22. def map[B](f: (A) => B): ContextMatcher[Elem, B]

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the transformation function f.

    Create a new ContextMatcher which takes the match result of this matcher and passes it through the transformation function f.

    B

    The transformed context type

    f

    The transformation function

    returns

    A new matcher with transformed results

    Definition Classes
    ContextMatcher
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def or[A2 >: A](that: ContextMatcher[Elem, A2]): ContextMatcher[Elem, A2]

    Create a new ContextMatcher which will fall back to a second matcher in the event that this matcher fails to match a context.

    Create a new ContextMatcher which will fall back to a second matcher in the event that this matcher fails to match a context.

    A2

    The resulting context type (common supertype between this matcher and that)

    that

    The matcher which will be used as the fallback

    returns

    A matcher that falls back to another matcher in case of failure

    Definition Classes
    ContextMatcher
  27. def productElementNames: Iterator[String]
    Definition Classes
    Product
  28. val right: ContextMatcher[Elem, A]
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    Or → AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. def |[A2 >: A](that: ContextMatcher[Elem, A2]): ContextMatcher[Elem, A2]

    Operator version of or

    Operator version of or

    Definition Classes
    ContextMatcher

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toStringFormat[Or[Elem, A]] 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): (Or[Elem, A], B)
    Implicit
    This member is added by an implicit conversion from Or[Elem, A] toArrowAssoc[Or[Elem, 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 ContextMatcher[Elem, A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromOr[Elem, A] to any2stringadd[Or[Elem, A]]

Inherited by implicit conversion StringFormat fromOr[Elem, A] to StringFormat[Or[Elem, A]]

Inherited by implicit conversion Ensuring fromOr[Elem, A] to Ensuring[Or[Elem, A]]

Inherited by implicit conversion ArrowAssoc fromOr[Elem, A] to ArrowAssoc[Or[Elem, A]]

Ungrouped