Class

checklist.refinement.RuleHListSyntax

RuleHList

Related Doc: package RuleHListSyntax

Permalink

implicit class RuleHList[A, B <: HList, Rev <: HList] extends AnyRef

Self Type
RuleHList[A, B, Rev]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RuleHList
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RuleHList(rule: Rule[A, B])(implicit reverse: Aux[B, Rev])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def append[C](c: ⇒ C): Rule[A, ::[C, B]]

    Permalink

    Adds a new property to the rule builder with an arbitrary value.

    Adds a new property to the rule builder with an arbitrary value.

    C

    The type of the property to be added

    c

    The value of the property to be added

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def build[C](implicit generic: Aux[C, Rev]): Rule[A, C]

    Permalink

    Finalizes the rule builder, and produces a more useful class as output, rather than an HList.

    Finalizes the rule builder, and produces a more useful class as output, rather than an HList.

    C

    The desired rule output type

  7. def check[C, D, E](path: E, f: (A) ⇒ C)(newRule: Rule[C, D])(implicit arg0: PathPrefix[E]): Rule[A, ::[D, B]]

    Permalink

    Adds a new property to the rule builder to be sanitzed and validated

    Adds a new property to the rule builder to be sanitzed and validated

    C

    The raw, unvalidated type which is pulled out of an A

    D

    The validated type, produced by running sanitization/validation provided by a Rule[C, D]

    E

    The type of the provided PathPrefix, usually a String.

    path

    The path to the property specified, for more helpful errors. Usually a String.

    f

    The function which picks a property of A to test

    newRule

    The rule with which to verify the property

  8. def check[C, D](f: (A) ⇒ C)(newRule: Rule[C, D]): Rule[A, ::[D, B]]

    Permalink

    Adds a new property to the rule builder to be sanitzed and validated.

    Adds a new property to the rule builder to be sanitzed and validated. You usually want to use the overload which lets you specify a path, but if you do not want to specify a path, use this one.

    C

    The raw, unvalidated type which is pulled out of an A

    D

    The validated type, produced by running sanitization/validation provided by a Rule[C, D]

    f

    The function which picks a property of A to test

    newRule

    The rule with which to verify the property

  9. def checkAndDrop[C](f: (A) ⇒ C)(rule: Rule[C, _]): Rule[A, B]

    Permalink

    Checks a property and discards the result.

    Checks a property and discards the result.

    C

    The raw, unvalidated type which is pulled out of an A

    f

    The function which picks a property of A to test

  10. def checkAndDrop[P, C](path: P, f: (A) ⇒ C)(rule: Rule[C, _])(implicit arg0: PathPrefix[P]): Rule[A, B]

    Permalink

    Checks a property and discards the result.

    Checks a property and discards the result.

    P

    The type of the provided PathPrefix, usually a String.

    C

    The raw, unvalidated type which is pulled out of an A

    path

    The path to the property specified, for more helpful errors. Usually a String.

    f

    The function which picks a property of A to test

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. def pass[C](f: (A) ⇒ C): Rule[A, ::[C, B]]

    Permalink

    Adds a new property to the rule builder, using the provided input type.

    Adds a new property to the rule builder, using the provided input type. Performs no sanitization/validation.

    C

    The type to be pulled from A

    f

    The function for getting a property from A

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

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped