scala.tools.scalap.scalax.rules

# RulesWithState

#### trait RulesWithState extends Rules with StateRules

Linear Supertypes
StateRules, Rules, AnyRef, Any
Known Subclasses
ByteCodeReader, ClassFileParser, ScalaSigAttributeParsers, ScalaSigEntryParsers, ScalaSigParsers, SourceFileAttributeParser
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. RulesWithState
2. StateRules
3. Rules
4. AnyRef
5. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Type Members

1. #### class DefaultRule [In, Out, A, X] extends Rule[In, Out, A, X]

   Definition Classes
     Rules

2. #### type Rule[+A, +X] = rules.Rule[S, S, A, X]

   Definition Classes
     StateRules

3. #### abstract type S

   Definition Classes
     StateRules

### Value Members

1. #### final def !=(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

2. #### final def !=(arg0: Any): Boolean

   Definition Classes
     Any

3. #### final def ##(): Int

   Definition Classes
     AnyRef → Any

4. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from RulesWithState to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (RulesWithState, B)

   Implicit information
     This member is added by an implicit conversion from RulesWithState to ArrowAssoc[RulesWithState] performed by method any2ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

6. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

7. #### final def ==(arg0: Any): Boolean

   Definition Classes
     Any

8. #### def allOf[A, X](rules: Seq[Rule[A, X]]): (S) ⇒ Result[S, List[A], X]

   Create a rule that succeeds if all of the given rules succeed.

   Create a rule that succeeds if all of the given rules succeed.

   rules

     the rules to apply in sequence.

   Definition Classes
     StateRules

9. #### def anyOf[A, X](rules: Seq[Rule[A, X]]): rules.Rule[S, S, collection.immutable.List[A], X]

   Create a rule that succeeds with a list of all the provided rules that succeed.

   Create a rule that succeeds with a list of all the provided rules that succeed.

   rules

     the rules to apply in sequence.

   Definition Classes
     StateRules

10. #### def apply[A, X](f: (S) ⇒ Result[S, A, X]): rules.Rule[S, S, A, X]

    Definition Classes
      StateRules

11. #### final def asInstanceOf[T0]: T0

    Definition Classes
      Any

12. #### def clone(): AnyRef

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

13. #### def cond(f: (S) ⇒ Boolean): rules.Rule[S, S, S, Nothing]

    Create a rule that identities if f(in) is true.

    Create a rule that identities if f(in) is true.

    Definition Classes
      StateRules

14. #### def ensuring(cond: (RulesWithState) ⇒ Boolean, msg: ⇒ Any): RulesWithState

    Implicit information
      This member is added by an implicit conversion from RulesWithState to Ensuring[RulesWithState] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

15. #### def ensuring(cond: (RulesWithState) ⇒ Boolean): RulesWithState

    Implicit information
      This member is added by an implicit conversion from RulesWithState to Ensuring[RulesWithState] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

16. #### def ensuring(cond: Boolean, msg: ⇒ Any): RulesWithState

    Implicit information
      This member is added by an implicit conversion from RulesWithState to Ensuring[RulesWithState] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

17. #### def ensuring(cond: Boolean): RulesWithState

    Implicit information
      This member is added by an implicit conversion from RulesWithState to Ensuring[RulesWithState] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

18. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

19. #### def equals(arg0: Any): Boolean

    Definition Classes
      AnyRef → Any

20. #### def error[X](err: X): rules.Rule[Any, Nothing, Nothing, X]

    Definition Classes
      Rules

21. #### def error[In]: rules.Rule[In, Nothing, Nothing, In]

    Definition Classes
      Rules

22. #### def expect[In, Out, A, Any](rule: rules.Rule[In, Out, A, Any]): (In) ⇒ A

    Converts a rule into a function that throws an Exception on failure.

    Converts a rule into a function that throws an Exception on failure.

    Definition Classes
      Rules

23. #### val factory: RulesWithState

    Definition Classes
      RulesWithState → StateRules

24. #### def failure: rules.Rule[Any, Nothing, Nothing, Nothing]

    Definition Classes
      Rules

25. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

26. #### def formatted(fmtstr: String): String

    Implicit information
      This member is added by an implicit conversion from RulesWithState to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

27. #### def from[In]: AnyRef { def apply[Out, A, X](f: In => scala.tools.scalap.scalax.rules.Result[Out,A,X]): scala.tools.scalap.scalax.rules.Rule[In,Out,A,X] }

    Definition Classes
      Rules

28. #### def get: rules.Rule[S, S, S, Nothing]

    Definition Classes
      StateRules

29. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

30. #### def hashCode(): Int

    Definition Classes
      AnyRef → Any

31. #### implicit def inRule[In, Out, A, X](rule: rules.Rule[In, Out, A, X]): InRule[In, Out, A, X]

    Definition Classes
      Rules

32. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

33. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

34. #### def nil: rules.Rule[S, S, collection.immutable.Nil.type, Nothing]

    Definition Classes
      StateRules

35. #### def none: rules.Rule[S, S, None.type, Nothing]

    Definition Classes
      StateRules

36. #### final def notify(): Unit

    Definition Classes
      AnyRef

37. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

38. #### def oneOf[In, Out, A, X](rules: rules.Rule[In, Out, A, X]*): rules.Rule[In, Out, A, X]

    Definition Classes
      Rules

39. #### def read[A](f: (S) ⇒ A): rules.Rule[S, S, A, Nothing]

    Definition Classes
      StateRules

40. #### def repeatUntil[T, X](rule: Rule[(T) ⇒ T, X])(finished: (T) ⇒ Boolean)(initial: T): rules.Rule[S, S, T, X]

    Repeatedly apply a rule from initial value until finished condition is met.

    Repeatedly apply a rule from initial value until finished condition is met.

    Definition Classes
      StateRules

41. #### implicit def rule[In, Out, A, X](f: (In) ⇒ Result[Out, A, X]): rules.Rule[In, Out, A, X]

    Definition Classes
      Rules

42. #### def ruleWithName[In, Out, A, X](_name: String, f: (In) ⇒ Result[Out, A, X]): rules.Rule[In, Out, A, X] with Name

    Definition Classes
      Rules

43. #### implicit def seqRule[In, A, X](rule: rules.Rule[In, In, A, X]): SeqRule[In, A, X]

    Definition Classes
      Rules

44. #### def set(s: ⇒ S): rules.Rule[S, S, S, Nothing]

    Definition Classes
      StateRules

45. #### def state[s]: StateRules { type S = s }

    Definition Classes
      Rules

46. #### def success[Out, A](out: Out, a: A): rules.Rule[Any, Out, A, Nothing]

    Definition Classes
      Rules

47. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

48. #### def toString(): String

    Definition Classes
      AnyRef → Any

49. #### def unit[A](a: ⇒ A): rules.Rule[S, S, A, Nothing]

    Definition Classes
      StateRules

50. #### def update(f: (S) ⇒ S): rules.Rule[S, S, S, Nothing]

    Definition Classes
      StateRules

51. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

52. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

53. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

54. #### def →[B](y: B): (RulesWithState, B)

    Implicit information
      This member is added by an implicit conversion from RulesWithState to ArrowAssoc[RulesWithState] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from RulesWithState to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (rulesWithState: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from RulesWithState to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (rulesWithState: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: RulesWithState

   Implicit information
     This member is added by an implicit conversion from RulesWithState to ArrowAssoc[RulesWithState] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (rulesWithState: ArrowAssoc[RulesWithState]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: RulesWithState

   Implicit information
     This member is added by an implicit conversion from RulesWithState to Ensuring[RulesWithState] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (rulesWithState: Ensuring[RulesWithState]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from StateRules

### Inherited from Rules

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from RulesWithState to StringAdd

### Inherited by implicit conversion any2stringfmt from RulesWithState to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from RulesWithState to ArrowAssoc[RulesWithState]

### Inherited by implicit conversion any2Ensuring from RulesWithState to Ensuring[RulesWithState]

### Ungrouped