RefType

Type class that allows F to be used as result type of a refinement. The first type parameter of F is the type that is being refined by its second type parameter which is the type-level predicate that denotes the refinement. Consequently, F[T, P] is a phantom type that only contains a value of type T.

The library provides instances of RefType for

the Refined value class
and shapeless.tag.@@ which is a subtype of its first parameter (i.e. (T @@ P) <: T)

Source: RefType.scala

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Type Hierarchy Learn more about scaladoc diagrams

Abstract Value Members

abstract def unsafeRewrapM[T, A, B](c: Context)(ta: scala.reflect.macros.blackbox.Context.Expr[F[T, A]])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[T], arg1: scala.reflect.macros.blackbox.Context.WeakTypeTag[A], arg2: scala.reflect.macros.blackbox.Context.WeakTypeTag[B]): scala.reflect.macros.blackbox.Context.Expr[F[T, B]]
abstract def unsafeWrap[T, P](t: T): F[T, P]
abstract def unsafeWrapM[T, P](c: Context)(t: scala.reflect.macros.blackbox.Context.Expr[T])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[T], arg1: scala.reflect.macros.blackbox.Context.WeakTypeTag[P]): scala.reflect.macros.blackbox.Context.Expr[F[T, P]]
abstract def unwrap[T, P](tp: F[T, P]): T

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
def mapRefine[T, P, U](tp: F[T, P])(f: (T) ⇒ U)(implicit p: Predicate[P, U]): Either[String, F[U, P]]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def refine[P]: RefineAux[F, P]

Returns a value of type T wrapped in F[T, P] on the right if it satisfies the predicate P, or an error message on the left otherwise.
Returns a value of type T wrapped in F[T, P] on the right if it satisfies the predicate P, or an error message on the left otherwise.
Example:
```
scala> import eu.timepit.refined._
     | import eu.timepit.refined.numeric._

scala> RefType[Refined].refine[Positive](10)
res1: Either[String, Refined[Int, Positive]] = Right(Refined(10))
```
Note: The return type is internal.RefineAux[F, P], which has an apply method on it, allowing refine to be called like in the given example.
def refineM[P]: RefineMAux[F, P]

Macro that returns a value of type T wrapped in F[T, P] if it satisfies the predicate P, or fails to compile otherwise.
Macro that returns a value of type T wrapped in F[T, P] if it satisfies the predicate P, or fails to compile otherwise.
Example:
```
scala> import eu.timepit.refined._
     | import eu.timepit.refined.numeric._

scala> RefType[Refined].refineM[Positive](10)
res1: Refined[Int, Positive] = Refined(10)
```
Note: M stands for macro.
Note: The return type is internal.RefineMAux[F, P], which has an apply method on it, allowing refineM to be called like in the given example.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RefType | package refined

trait RefType[F[_, _]] extends Serializable

Abstract Value Members

abstract def unsafeWrap[T, P](t: T): F[T, P]

abstract def unsafeWrapM[T, P](c: Context)(t: scala.reflect.macros.blackbox.Context.Expr[T])(implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[T], arg1: scala.reflect.macros.blackbox.Context.WeakTypeTag[P]): scala.reflect.macros.blackbox.Context.Expr[F[T, P]]

abstract def unwrap[T, P](tp: F[T, P]): T

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mapRefine[T, P, U](tp: F[T, P])(f: (T) ⇒ U)(implicit p: Predicate[P, U]): Either[String, F[U, P]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def refine[P]: RefineAux[F, P]

def refineM[P]: RefineMAux[F, P]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped