Object/Trait

eu.timepit.refined.api

RefType

Related Docs: trait RefType | package api

Permalink

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
Visibility
  1. Public
  2. All

Type Members

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

    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 apply[F[_, _]](implicit rt: RefType[F]): RefType[F]

    Permalink

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

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

    Permalink

    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.

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

    Permalink

    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.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
  18. object ops

    Permalink
  19. implicit val refinedRefType: RefType[Refined]

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

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

    Permalink
  22. def toString(): String

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped