microsite
API
Generated with
microsite/izumi/izumi.distage/izumi.distage.model/izumi.distage.model.providers

izumi.distage.model.providers

package izumi.distage.model.providers

Members list

Type members

Classlikes

trait AbstractFunctoid[+A, Ftoid <: ([X] =>> AbstractFunctoid[X, Ftoid])]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Functoid[A]
object Functoid extends SimpleFunctoidSyntax[Functoid], SimpleDistageFunctoids, FunctoidMacroMethods, FunctoidBindImplicitsVersionSpecific

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Functoid.type
final case class Functoid[+A](get: Provider) extends AbstractFunctoid[A, Functoid]

A function that receives its arguments from DI object graph, including named instances via izumi.distage.model.definition.Id annotation.

A function that receives its arguments from DI object graph, including named instances via izumi.distage.model.definition.Id annotation.

The following syntaxes are supported by extractor macro:

Inline lambda:

 make[Unit].from {
   i: Int @Id("special") => ()
 }

Method reference:

 def constructor(@Id("special") i: Int): Unit = ()

 make[Unit].from(constructor _)

 make[Unit].from(constructor(_))

Function value with an annotated signature:

 val constructor: (Int @Id("special"), String @Id("special")) => Unit = (_, _) => ()

 make[Unit].from(constructor)

Using intermediate vals will lose annotations when converting a method into a function value, Prefer passing inline lambdas such as { x => y } or method references such as (method _) or (method(_)).:

 def constructorMethod(@Id("special") i: Int): Unit = ()

 val constructor = constructorMethod _

 make[Unit].from(constructor) // SURPRISE: Will summon regular Int, not a "special" Int from DI object graph
 make[Unit].from(constructorMethod _) // Will work correctly: summon "special" Int

Prefer annotating parameter types, not parameters: class X(i: Int @Id("special")) { ... }

 final case class X(i: Int @Id("special"))

 make[X].from(X.apply _) // summons special Int

Functoid forms an applicative functor via its izumi.distage.model.providers.Functoid.pure & izumi.distage.model.providers.AbstractFunctoid.map2 methods

Attributes

See also

Functoid is based on the Magnet Pattern: http://spray.io/blog/2012-12-13-the-magnet-pattern/

Essentially Functoid is a function-like entity with additional properties, so it's funny name is reasonable enough: https://en.wiktionary.org/wiki/-oid#English

Note

javax.inject.Named annotation is also supported

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait FunctoidBindImplicitsVersionSpecific

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait AbstractBindingDefDSL[BindDSL, BindDSLAfterFrom, SetDSL]
trait ModuleDefDSL
trait ModuleDef
class PluginDef[T]
class LogIOModule[F]
class LogIO2Module[F]
class LogIO3Module[F]
trait LocatorDef
object Functoid
Show all
trait SimpleDistageFunctoids

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Functoid
trait SimpleFunctoidSyntax[Ftoid <: ([X] =>> AbstractFunctoid[X, Ftoid])]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Functoid
object SimpleFunctoidSyntax

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with