Trait/Object

kantan.regex

Compiler

Related Docs: object Compiler | package regex

Permalink

trait Compiler[E] extends AnyRef

Type class for types that can be compiled to instances of Regex.

While regular expression literals are usually the preferred way of creating instances of Regex, they don't fit all possible situations - one might imagine, for example, a scenario where a regular expression is created dynamically before being compiled.

Compiler is provided for these cases where literals are not an option. The preferred way of using it is to make sure the corresponding syntax is in scope and use the asRegex method:

// Obtain a regular expression as a string somehow.
val regex: String = ???

// Promote it to a Regex[Int]
regex.asRegex[Int]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Compiler
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def compile[A](expr: E)(implicit db: MatchDecoder[A]): CompileResult[Regex[DecodeResult[A]]]

    Permalink

    Compiles the specified expression into a Regex.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def compile[A](expr: E, group: Int)(implicit arg0: GroupDecoder[A]): CompileResult[Regex[DecodeResult[A]]]

    Permalink

    Compiles the specified expression into a Regex.

    Compiles the specified expression into a Regex.

    This is useful when you're only interested in a specific group of each match, and that group is of a type that already has a GroupDecoder - typically, a primitive type. For example:

    // An example match will be [123], with the first equal to 123. That's the bit we want to extract
    // as an int.
    compiler.compile[Int]("""\[(\d+)\]""", 1)

    A MatchDecoder[A] will be generated by calling MatchDecoder.fromGroup with the specified group value.

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  18. def unsafeCompile[A](expr: E, group: Int)(implicit arg0: GroupDecoder[A]): Regex[DecodeResult[A]]

    Permalink

    Unsafe version of compile.

    Unsafe version of compile.

    Annotations
    @SuppressWarnings()
  19. def unsafeCompile[A](expr: E)(implicit arg0: MatchDecoder[A]): Regex[DecodeResult[A]]

    Permalink

    Unsafe version of compile.

    Unsafe version of compile.

    Annotations
    @SuppressWarnings()
  20. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped