Packages

•  package root

  A library for writing custom string interpolation implementations via parser combinators

  A library for writing custom string interpolation implementations via parser combinators

  ## Entry Points

  If the string context should create an object: Create leaf parsers using the methods in the Interpolator companion object, combine and manipulate them with the methods in Interpolator, then interpolate using the final Interpolator's interpolate method.

  If the string context should create an extractor: Create leaf parsers using the methods in the Extractor companion object, combine and manipulate them with the methods in Extractor, then interpolate using the final Extractor's extractor method.

  If the string context should do both: Create leaf parsers using the methods in the Parser companion object, combine and manipulate them with the methods in Parser, then interpolate using the final Parser's interpolate and extractor methods.

  Definition Classes

  root

•  package name

  Definition Classes

  root

•  package rayrobdod

  Definition Classes

  name

•  package stringContextParserCombinator

  A library for implementing custom string interpolation implementations using Parser Combinators

  A library for implementing custom string interpolation implementations using Parser Combinators

  Definition Classes

  rayrobdod

•  package typeclass

  Implicit values used by branch combinators that allow combinations of input types to have more ergonomic return types.

  Implicit values used by branch combinators that allow combinations of input types to have more ergonomic return types.

  Each of the typeclasses defined in this package fit into a matrix, where one dimension is which type of parser the typeclass is used with and the other dimension is the method that uses an instance of the type

  method	Covariant (Interpolator)	Contravariant (Extractor)	Invariant (Parser)
  andThen	Sequenced	ContraSequenced	BiSequenced
  orElse	Eithered	ContraEithered	BiEithered
  repeat	Repeated	ContraRepeated	BiRepeated
  optionally	Optionally	ContraOptionally	BiOptionally
  mapToExpr	ToExprMapping	N/A	N/A

  Thus, if you are only working with interpolators, then you'll only need to work with the unprefixed typeclasses.

  Each of these traits has a companion object that defines a generic instance of the trait, and a few instances for more specific types. For instance, each typeclass includes a instance that will avoid wrapping scala.Unit values in a collection or tuple.

  Defining custom instances of these types is supported. Making custom given instances can significantly reduce the number of explicit map calls required when writing a parser, however the usual advice with given instances applies: keep types specific, or keep the scope of a given instance to the minimum viable to prevent given instances from becoming confusing.

  Definition Classes

  stringContextParserCombinator

• CodePoint
• Extractor
• Interpolator
• LiftFunction
• ParseException
• Parser
• PartialExprFunction
• RepeatStrategy
• Unapply

name.rayrobdod.stringContextParserCombinator

Extractor

Companion class Extractor