RulesWithState

Value Members

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

   

   Test two objects for inequality.

   Test two objects for inequality.

   returns

   true if !(this == that), false otherwise.

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Equivalent to x.hashCode except for boxed numeric types and null.

   Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

   returns

   a hash value consistent with ==

   Definition Classes

   AnyRef → Any

3. def +(other: String): String

   

   Implicit information

   This member is added by an implicit conversion from RulesWithState to any2stringadd[RulesWithState] performed by method any2stringadd in scala.Predef.

   Definition Classes

   any2stringadd

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

   

   Implicit information

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

   Definition Classes

   ArrowAssoc

   Annotations

   @inline()

5. final def ==(arg0: Any): Boolean

   

   The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

   The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

   returns

   true if the receiver object is equivalent to the argument; false otherwise.

   Definition Classes

   AnyRef → Any

6. 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

7. 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

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

   

   Definition Classes

   StateRules

9. final def asInstanceOf[T0]: T0

   

   Cast the receiver object to be of type T0.

   Cast the receiver object to be of type T0.

   Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

   returns

   the receiver object.

   Definition Classes

   Any

   Exceptions thrown

   ClassCastException if the receiver object is not an instance of the erasure of type T0.

10. def clone(): AnyRef

    

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

    Note

    not specified by SLS as a member of AnyRef

11. 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

12. 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 Ensuring in scala.Predef.

    Definition Classes

    Ensuring

13. def ensuring(cond: (RulesWithState) ⇒ Boolean): RulesWithState

    

    Implicit information

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

    Definition Classes

    Ensuring

14. 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 Ensuring in scala.Predef.

    Definition Classes

    Ensuring

15. def ensuring(cond: Boolean): RulesWithState

    

    Implicit information

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

    Definition Classes

    Ensuring

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

    

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes

    AnyRef

17. def equals(arg0: Any): Boolean

    

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Rules

19. def error[In]: rules.Rule[In, Nothing, Nothing, In]

    

    Definition Classes

    Rules

20. 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

21. val factory: RulesWithState

    

    Definition Classes

    RulesWithState → StateRules

22. def failure: rules.Rule[Any, Nothing, Nothing, Nothing]

    

    Definition Classes

    Rules

23. def finalize(): Unit

    

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

    Note

    not specified by SLS as a member of AnyRef

24. def formatted(fmtstr: String): String

    

    Implicit information

    This member is added by an implicit conversion from RulesWithState to StringFormat[RulesWithState] performed by method StringFormat in scala.Predef.

    Definition Classes

    StringFormat

    Annotations

    @inline()

25. def from[In]: FromRule[In]

    

    Definition Classes

    Rules

26. def get: rules.Rule[S, S, S, Nothing]

    

    Definition Classes

    StateRules

27. final def getClass(): Class[_]

    

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes

    AnyRef → Any

    Note

    not specified by SLS as a member of AnyRef

28. def hashCode(): Int

    

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    Rules

30. final def isInstanceOf[T0]: Boolean

    

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes

    Any

31. final def ne(arg0: AnyRef): Boolean

    

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes

    AnyRef

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

    

    Definition Classes

    StateRules

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

    

    Definition Classes

    StateRules

34. final def notify(): Unit

    

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes

    AnyRef

    Note

    not specified by SLS as a member of AnyRef

35. final def notifyAll(): Unit

    

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes

    AnyRef

    Note

    not specified by SLS as a member of AnyRef

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

    

    Definition Classes

    Rules

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

    

    Definition Classes

    StateRules

38. 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

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

    

    Definition Classes

    Rules

40. 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

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

    

    Definition Classes

    Rules

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

    

    Definition Classes

    StateRules

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

    

    Definition Classes

    Rules

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

    

    Definition Classes

    Rules

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

    

    Definition Classes

    AnyRef

46. def toString(): String

    

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes

    AnyRef → Any

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

    

    Definition Classes

    StateRules

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

    

    Definition Classes

    StateRules

49. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

51. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Implicit information

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

    Definition Classes

    ArrowAssoc