Type Members

1.  sealed case class CompileError(message: String) extends RegexError with Product with Serializable

   Describes errors that occur while compiling a regular expression.

2.  type CompileResult[A] = Either[CompileError, A]

   Result type for compilation operations.

3.  trait Compiler[E] extends AnyRef

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

   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]

4.  sealed abstract class DecodeError extends RegexError
5.  type DecodeResult[A] = Either[DecodeError, A]

   Result type for decoding operations.

6.  trait GeneratedMatchDecoders extends AnyRef
7.  type GroupDecoder[A] = Decoder[Option[String], A, DecodeError, codecs.type]

   Type class for types that can be decoded from capturing groups.

   Type class for types that can be decoded from capturing groups.

   See the companion object for instance creation methods.

8.  trait GroupDecoderInstances extends AnyRef

   Declares all default GroupDecoder instances.

9.  class Match extends AnyRef

   Represents a single match in a regular expression evaluation.

   Represents a single match in a regular expression evaluation.

   It's usually better not to interact with Match directly - more often than not, adapting existing instances of MatchDecoder is the better solution. When in a situation where you *must* deal with such values directly, it's important not to hold onto them: due to the way kantan.regex works internally, Match is mutable.

10.  type MatchDecoder[A] = Decoder[Match, A, DecodeError, codecs.type]

    Type class for type that can be decoded from regular expression matches.

    Type class for type that can be decoded from regular expression matches.

    See the companion object for instance creation methods.

11.  trait MatchDecoderInstances extends AnyRef

    Declares default MatchDecoder instances.

12.  type Pattern = java.util.regex.Pattern
13.  trait PlatformSpecificInstances extends AnyRef
14.  trait Regex[A] extends AnyRef

    Compiled version of a regular expression.

15.  sealed abstract class RegexError extends Error

    Root class for all regular expression related errors.

16.  type RegexResult[A] = Either[RegexError, A]

    Result type for all regex related operations (encompasses both DecodeResult and CompileResult.

17.  trait TupleDecoders extends AnyRef