ByName

A type class for convert between by-name type and normal by-value type.

Installation

libraryDependencies += "com.thoughtworks.feature" %% "byname" % "latest.release"

This ByName type class provide an extension method extract for ByName.=> types via implicit view, which can be import as follow:

import com.thoughtworks.feature.ByName.ops._

Author:

杨博 (Yang Bo) <[email protected]>

ByNameType: The by-name type

Annotations

@implicitNotFound( ... )

Source

ByName.scala

Note

When using this ByName type class, you should make sure the type parameter ByNameType is an abstract type, in case of Scala compiler bugs. You can use a trick similar to C++'s Pimpl Idiom to create opacity abstract types

import com.thoughtworks.feature.ByName.`=>`
trait OpacityTypes {
  type IntByName
  implicit def typeClass: ByName.Aux[IntByName, Int]
}
val opacityTypes: OpacityTypes = new OpacityTypes {
  type IntByName = `=>`[Int]
  override def typeClass = ByName[IntByName]
}
import opacityTypes._

Now IntByName is an abstract type with underlying => Int type.

Given a by-name parameter of the return value of getInt(),

val getInt = stubFunction[Int]
val boxedByName: IntByName = typeClass.make(getInt())

when getInt returns 42,

getInt.when.once returns 42

then the value of the the by-name parameter should be 42;

boxedByName.extract should be(42)

when getInt returns 144,

getInt.when.once returns 144

then the value of the the by-name parameter should be 144.

boxedByName.extract should be(144)

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Type Hierarchy

Type Members

abstract type Value

Abstract Value Members

abstract def extract(byName: ByNameType): Value
abstract def make(byName: ⇒ Value): ByNameType

Creates a by-name parameter.

Concrete Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to any2stringadd[ByName[ByNameType]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ByName[ByNameType], B)

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to ArrowAssoc[ByName[ByNameType]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
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( ... )
def ensuring(cond: (ByName[ByNameType]) ⇒ Boolean, msg: ⇒ Any): ByName[ByNameType]

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to Ensuring[ByName[ByNameType]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ByName[ByNameType]) ⇒ Boolean): ByName[ByNameType]

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to Ensuring[ByName[ByNameType]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ByName[ByNameType]

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to Ensuring[ByName[ByNameType]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ByName[ByNameType]

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to Ensuring[ByName[ByNameType]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
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] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to StringFormat[ByName[ByNameType]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
def →[B](y: B): (ByName[ByNameType], B)

Implicit information
This member is added by an implicit conversion from ByName[ByNameType] to ArrowAssoc[ByName[ByNameType]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object ByName | package feature

trait ByName[ByNameType] extends Serializable

Installation

Author:

Type Members

abstract type Value

Abstract Value Members

abstract def extract(byName: ByNameType): Value

abstract def make(byName: ⇒ Value): ByNameType

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ByName[ByNameType], B)

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def ensuring(cond: (ByName[ByNameType]) ⇒ Boolean, msg: ⇒ Any): ByName[ByNameType]

def ensuring(cond: (ByName[ByNameType]) ⇒ Boolean): ByName[ByNameType]

def ensuring(cond: Boolean, msg: ⇒ Any): ByName[ByNameType]

def ensuring(cond: Boolean): ByName[ByNameType]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def →[B](y: B): (ByName[ByNameType], B)

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ByName[ByNameType] to any2stringadd[ByName[ByNameType]]

Inherited by implicit conversion StringFormat from ByName[ByNameType] to StringFormat[ByName[ByNameType]]

Inherited by implicit conversion Ensuring from ByName[ByNameType] to Ensuring[ByName[ByNameType]]

Inherited by implicit conversion ArrowAssoc from ByName[ByNameType] to ArrowAssoc[ByName[ByNameType]]

Ungrouped