abstract class Newtype[Src] extends NewtypeTrait[Src]
Base class for defining newtypes that have no type parameters.
This class does not define any "builder", or related HasBuilder instance, as you're expected to provide one yourself.
Usage sample:
type EmailAddress = EmailAddress.Type object EmailAddress extends Newtype[String] { self => def apply(value: String): Option[Type] = if (value.contains("@")) Some(unsafeCoerce(value)) else None // Recommended instance, but not required; // use Newtype.Validated to get rid of this boilerplate ;-) implicit val builder: HasBuilder.Aux[EmailAddress, String] = new HasBuilder[EmailAddress] { type Source = String def build(v: String): Either[BuildFailure[Type], Type] = apply(v) match { case Some(r) => Right(r) case None => Left(BuildFailure[EmailAddress]("missing @")) } } }
- Source
- Newtype.scala
- See also
NewtypeWrapped and NewtypeValidated for variants that provide an
apply
builder.Newsubtype for defining _subtypes_ of the underlying type.
Linear Supertypes
Known Subclasses
Ordering
- Alphabetic
- By Inheritance
Inherited
- Newtype
- NewtypeTrait
- NewEncoding
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new Newtype()
Type Members
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def derive[F[_]](implicit ev: F[Src]): F[Type]
- Attributes
- protected
- Definition Classes
- NewEncoding
- Annotations
- @inline()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def extract(value: Type): Src
- Attributes
- protected
- Definition Classes
- NewEncoding
- Annotations
- @inline()
- implicit final val extractor: Aux[Type, Src]
- Definition Classes
- NewEncoding
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit val typeInfo: TypeInfo[Type]
- Definition Classes
- NewEncoding
- final def unsafeCoerce(value: Src): Type
- Attributes
- protected
- Definition Classes
- NewEncoding
- Annotations
- @inline()
- final def value(x: Type): Src
- Definition Classes
- NewEncoding
- Annotations
- @inline()
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Macro-free helpers for defining newtypes in Scala.
Links: