string-context-parser-combinator0.1.1 < Back

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.

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

object Extractor extends VersionSpecificExtractorModule

Source: Extractor.scala

Linear Supertypes

VersionSpecificExtractorModule, AnyRef, Any

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Extractor
VersionSpecificExtractorModule
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

trait Extractors[Expr[+_], Type[_]] extends AnyRef
A trait that provides Extractor factory methods that conform to a particular input Expr type parameter.
A trait that provides Extractor factory methods that conform to a particular input Expr type parameter.
In scala 3, the Extractor companion object contains methods similar to these for quoted.Expr, and as such this would generally by calling methods directly on Extractor. However, since in scala 2 the Expr depends on a particular instance of blackbox.Context, instead an Extractors must be constructed from the Extractor companion object's macroExtractors method that takes a Context.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def contextExtractors(c: Context): Extractors[scala.reflect.macros.blackbox.Context.Expr, scala.reflect.macros.blackbox.Context.TypeTag]
Create a Extractors that can parse Exprs belonging to the specified Context
Create a Extractors that can parse Exprs belonging to the specified Context

Definition Classes
VersionSpecificExtractorModule
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
val idExtractors: Extractors[Id, ClassTag]
Returns an Extractors that can parse raw values
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lazy[Expr[_], Type[_], A](fn: () ⇒ Extractor[Expr, Type, A]): Extractor[Expr, Type, A]
Indirectly refers to a parser, to allow for mutual-recursion
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()

Packages

Entry Points

Extractor

Companion class Extractor

object Extractor extends VersionSpecificExtractorModule

Type Members

Value Members

Inherited from VersionSpecificExtractorModule

Inherited from AnyRef

Inherited from Any

Miscellaneous

Ungrouped

ExtractorGroup

Packages

Entry Points

Extractor 

Companion class Extractor

object Extractor extends VersionSpecificExtractorModule

Type Members

Value Members

Inherited from VersionSpecificExtractorModule

Inherited from AnyRef

Inherited from Any

Miscellaneous

Ungrouped

ExtractorGroup

Extractor