sealed class Rule[-I <: HList, +O <: HList] extends RuleX

The general model of a parser rule. It is characterized by consuming a certain number of elements from the value stack (whose types are captured by the HList type parameter I for "Input") and itself pushing a certain number of elements onto the value stack (whose types are captured by the HList type parameter O for "Output").

At runtime there are only two instances of this class which signal whether the rule has matched (or mismatched) at the current point in the input.

Linear Supertypes
RuleX, AnyRef, Any
Known Subclasses
Rule
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Rule
  2. RuleX
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Rule()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def *(separator: Rule0)(implicit l: Lifter[Seq, I, O]): Rule[In, OptionalOut]

    Postfix shortcut for zeroOrMore(...).separatedBy(...).

    Postfix shortcut for zeroOrMore(...).separatedBy(...).

    Annotations
    @compileTimeOnly( ... )
  4. def *(implicit l: Lifter[Seq, I, O]): Rule[In, OptionalOut] with Repeated

    Postfix shortcut for zeroOrMore.

    Postfix shortcut for zeroOrMore.

    Annotations
    @compileTimeOnly( ... )
  5. def +(separator: Rule0)(implicit l: Lifter[Seq, I, O]): Rule[In, StrictOut]

    Postfix shortcut for oneOrMore(...).separatedBy(...).

    Postfix shortcut for oneOrMore(...).separatedBy(...).

    Annotations
    @compileTimeOnly( ... )
  6. def +(implicit l: Lifter[Seq, I, O]): Rule[In, StrictOut] with Repeated

    Postfix shortcut for oneOrMore.

    Postfix shortcut for oneOrMore.

    Annotations
    @compileTimeOnly( ... )
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def ?(implicit l: Lifter[Option, I, O]): Rule[In, OptionalOut]

    Postfix shortcut for optional.

    Postfix shortcut for optional.

    Annotations
    @compileTimeOnly( ... )
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def named(name: String): Rule.this.type

    Attaches the given explicit name to this rule.

    Attaches the given explicit name to this rule.

    Annotations
    @compileTimeOnly( ... )
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def unary_!: Rule0

    Creates a "negative syntactic predicate", i.e.

    Creates a "negative syntactic predicate", i.e. a rule that matches only if this rule mismatches and vice versa. The resulting rule doesn't cause the parser to make any progress (i.e. match any input) and also clears out all effects that the underlying rule might have had on the value stack.

    Annotations
    @compileTimeOnly( ... )
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. def |[I2 <: I, O2 >: O <: HList](that: Rule[I2, O2]): Rule[I2, O2]

    Combines this rule with the given other one in a way that the resulting rule matches if this rule matches or the other one matches.

    Combines this rule with the given other one in a way that the resulting rule matches if this rule matches or the other one matches. If this rule doesn't match the parser is reset and the given alternative tried. This operators therefore implements the "ordered choice' PEG combinator.

    Annotations
    @compileTimeOnly( ... )
  28. def ~[I2 <: HList, O2 <: HList](that: Rule[I2, O2])(implicit i: TailSwitch[I2, O, I], o: TailSwitch[O, I2, O2]): Rule[Out, Out]

    Concatenates this rule with the given other one.

    Concatenates this rule with the given other one. The resulting rule type is computed on a type-level. Here is an illustration (using an abbreviated HList notation): Rule[, A] ~ Rule[, B] = Rule[, A:B] Rule[A:B:C, D:E:F] ~ Rule[F, G:H] = Rule[A:B:C, D:E:G:H] Rule[A, B:C] ~ Rule[D:B:C, E:F] = Rule[D:A, E:F]

    Annotations
    @compileTimeOnly( ... )
  29. def ~!~[I2 <: HList, O2 <: HList](that: Rule[I2, O2])(implicit i: TailSwitch[I2, O, I], o: TailSwitch[O, I2, O2]): Rule[Out, Out]

    Same as ~ but with "cut" semantics, meaning that the parser will never backtrack across this boundary.

    Same as ~ but with "cut" semantics, meaning that the parser will never backtrack across this boundary. If the rule being concatenated doesn't match a parse error will be triggered immediately.

    Annotations
    @compileTimeOnly( ... )

Inherited from RuleX

Inherited from AnyRef

Inherited from Any

Ungrouped