# Rule

#### trait Rule[-In, +Out, +A, +X] extends (In) ⇒ Result[Out, A, X]

A Rule is a function from some input to a Result. The result may be:

• Success, with a value of some type and an output that may serve as the input to subsequent rules.
• Failure. A failure may result in some alternative rule being applied.
• Error. No further rules should be attempted.
Linear Supertypes
(In) ⇒ Result[Out, A, X], AnyRef, Any
Known Subclasses
Ordering
1. Alphabetic
2. By inheritance
Inherited
1. Rule
2. Function1
3. AnyRef
4. Any
Implicitly
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc
1. Hide All
2. Show all
Visibility
1. Public
2. All

### Abstract Value Members

1. #### abstract def apply(v1: In): Result[Out, A, X]

Definition Classes
Function1

### Concrete Value Members

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

Definition Classes
AnyRef → Any
2. #### def !^[Y](fx2y: (X) ⇒ Y): Rule[In, Out, A, Y]

Maps an Error

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

Definition Classes
AnyRef → Any
4. #### def +(other: String): String

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to any2stringadd[Rule[In, Out, A, X]] performed by method any2stringadd in scala.Predef.
Definition Classes

6. #### def ->[B](y: B): (Rule[In, Out, A, X], B)

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to ArrowAssoc[Rule[In, Out, A, X]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

10. #### def <~:[InPrev, B, X2 >: X](prev: ⇒ Rule[InPrev, In, (A) ⇒ B, X2]): Rule[InPrev, Out, B, X2]

Apply the result of this rule to the function returned by the previous rule

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

Definition Classes
AnyRef → Any

16. #### def >~>[Out2, B1, B2, B >: A, C, X2 >: X](f: (B1, B2) ⇒ (Out) ⇒ Result[Out2, C, X2])(implicit arg0: (B) ⇒ ~[B1, B2]): Rule[In, Out2, C, X2]

>~>(f) is equivalent to >> { case b1 ~ b2 => f(b1, b2) }

18. #### def ^-^[B1, B2 >: A, C](f: (B1, B2) ⇒ C): Rule[In, Out, (B1) ⇒ C, X]

-(f) is equivalent to ^^ { b2 => b1 => f(b1, b2) }

21. #### def ^~>~^[B1, B2, B3, B >: A, C](f: (B1, B2, B3) ⇒ C)(implicit arg0: (B) ⇒ ~[B2, B3]): Rule[In, Out, (B1) ⇒ C, X]

~>~(f) is equivalent to ^^ { case b2 ~ b3 => b1 => f(b1, b2, b3) }

22. #### def ^~^[B1, B2, B >: A, C](f: (B1, B2) ⇒ C)(implicit arg0: (B) ⇒ ~[B1, B2]): Rule[In, Out, C, X]

~(f) is equivalent to ^^ { case b1 ~ b2 => f(b1, b2) }

23. #### def ^~~^[B1, B2, B3, B >: A, C](f: (B1, B2, B3) ⇒ C)(implicit arg0: (B) ⇒ ~[~[B1, B2], B3]): Rule[In, Out, C, X]

~~(f) is equivalent to ^^ { case b1 ~ b2 ~ b3 => f(b1, b2, b3) }

24. #### def ^~~~^[B1, B2, B3, B4, B >: A, C](f: (B1, B2, B3, B4) ⇒ C)(implicit arg0: (B) ⇒ ~[~[~[B1, B2], B3], B4]): Rule[In, Out, C, X]

~~~(f) is equivalent to ^^ { case b1 ~ b2 ~ b3 ~ b4 => f(b1, b2, b3, b4) }

25. #### def ^~~~~^[B1, B2, B3, B4, B5, B >: A, C](f: (B1, B2, B3, B4, B5) ⇒ C)(implicit arg0: (B) ⇒ ~[~[~[~[B1, B2], B3], B4], B5]): Rule[In, Out, C, X]

~~~~(f) is equivalent to ^^ { case b1 ~ b2 ~ b3 ~ b4 ~ b5 => f(b1, b2, b3, b4, b5) }

26. #### def ^~~~~~^[B1, B2, B3, B4, B5, B6, B >: A, C](f: (B1, B2, B3, B4, B5, B6) ⇒ C)(implicit arg0: (B) ⇒ ~[~[~[~[~[B1, B2], B3], B4], B5], B6]): Rule[In, Out, C, X]

~~~~~(f) is equivalent to ^^ { case b1 ~ b2 ~ b3 ~ b4 ~ b5 ~ b6 => f(b1, b2, b3, b4, b5, b6) }

27. #### def ^~~~~~~^[B1, B2, B3, B4, B5, B6, B7, B >: A, C](f: (B1, B2, B3, B4, B5, B6, B7) ⇒ C)(implicit arg0: (B) ⇒ ~[~[~[~[~[~[B1, B2], B3], B4], B5], B6], B7]): Rule[In, Out, C, X]

~~~~~~(f) is equivalent to ^^ { case b1 ~ b2 ~ b3 ~ b4 ~ b5 ~ b6 => f(b1, b2, b3, b4, b5, b6) }

28. #### def andThen[A](g: (Result[Out, A, X]) ⇒ A): (In) ⇒ A

Definition Classes
Function1
Annotations
@unspecialized()

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

Definition Classes
Any
31. #### def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
32. #### def compose[A](g: (A) ⇒ In): (A) ⇒ Result[Out, A, X]

Definition Classes
Function1
Annotations
@unspecialized()
33. #### def ensuring(cond: (Rule[In, Out, A, X]) ⇒ Boolean, msg: ⇒ Any): Rule[In, Out, A, X]

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to Ensuring[Rule[In, Out, A, X]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
34. #### def ensuring(cond: (Rule[In, Out, A, X]) ⇒ Boolean): Rule[In, Out, A, X]

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to Ensuring[Rule[In, Out, A, X]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
35. #### def ensuring(cond: Boolean, msg: ⇒ Any): Rule[In, Out, A, X]

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to Ensuring[Rule[In, Out, A, X]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
36. #### def ensuring(cond: Boolean): Rule[In, Out, A, X]

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to Ensuring[Rule[In, Out, A, X]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
37. #### final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
38. #### def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any

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

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

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

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to StringFormat[Rule[In, Out, A, X]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
43. #### final def getClass(): Class[_]

Definition Classes
AnyRef → Any
44. #### def hashCode(): Int

Definition Classes
AnyRef → Any
45. #### final def isInstanceOf[T0]: Boolean

Definition Classes
Any

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

Definition Classes
AnyRef
49. #### final def notify(): Unit

Definition Classes
AnyRef
50. #### final def notifyAll(): Unit

Definition Classes
AnyRef

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

Definition Classes
AnyRef
54. #### def toString(): String

Definition Classes
Function1 → AnyRef → Any
55. #### final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

64. #### def ~>[Out2, B, X2 >: X](next: ⇒ Rule[Out, Out2, (A) ⇒ B, X2]): Rule[In, Out2, B, X2]

Apply the result of this rule to the function returned by the next rule

65. #### def →[B](y: B): (Rule[In, Out, A, X], B)

Implicit information
This member is added by an implicit conversion from Rule[In, Out, A, X] to ArrowAssoc[Rule[In, Out, A, X]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc