eu.timepit.refined.api

RefType

object RefType extends Serializable

Source
RefType.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. RefType
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. final class RefTypeOps[F[_, _], T, P] extends AnyRef

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. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def apply[F[_, _]](implicit rt: RefType[F]): RefType[F]

    Returns a RefType for the given type F from the implicit scope.

  7. def applyRef[FTP]: ApplyRefPartiallyApplied[FTP]

    Returns a value of type T refined as FTP on the right if it satisfies the predicate in FTP, or an error message on the left otherwise.

    Returns a value of type T refined as FTP on the right if it satisfies the predicate in FTP, or an error message on the left otherwise.

    Example:

    scala> import eu.timepit.refined.api.{ Refined, RefType }
         | import eu.timepit.refined.numeric.Positive
    
    scala> type PosInt = Int Refined Positive
    scala> RefType.applyRef[PosInt](10)
    res0: Either[String, PosInt] = Right(10)

    Note: The return type is internal.ApplyRefPartiallyApplied[FTP], which has an apply method on it, allowing applyRef to be called like in the given example.

  8. def applyRefM[FTP]: ApplyRefMPartiallyApplied[FTP]

    Macro that returns a value of type T refined as FTP if it satisfies the predicate in FTP, or fails to compile otherwise.

    Macro that returns a value of type T refined as FTP if it satisfies the predicate in FTP, or fails to compile otherwise.

    Example:

    scala> import eu.timepit.refined.api.{ Refined, RefType }
         | import eu.timepit.refined.numeric.Positive
    
    scala> type PosInt = Int Refined Positive
    scala> RefType.applyRefM[PosInt](10)
    res0: PosInt = 10

    Note: M stands for macro.

    Note: The return type is internal.ApplyRefMPartiallyApplied[FTP], which has an apply method on it, allowing applyRefM to be called like in the given example.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

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

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

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

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. object ops

  21. implicit val refinedRefType: RefType[Refined]

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

    Definition Classes
    AnyRef
  23. implicit val tagRefType: RefType[@@]

  24. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped