Packages

sealed abstract class ZLayer[-RIn, +E, +ROut] extends AnyRef

A ZLayer[A, E, B] describes a layer of an application: every layer in an application requires some services (the input) and produces some services (the output).

Layers can be thought of as recipes for producing bundles of services, given their dependencies (other services).

Construction of layers can be effectful and utilize resources that must be acquired and safely released when the services are done being utilized.

By default layers are shared, meaning that if the same layer is used twice the layer will only be allocated a single time.

Because of their excellent composition properties, layers are the idiomatic way in ZIO to create services that depend on other services.

Self Type
ZLayer[RIn, E, ROut]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZLayer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !(implicit ev1: <:<[E, Throwable], ev2: CanFail[E]): ZLayer[RIn, Nothing, ROut]

    A symbolic alias for orDie.

  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def +!+[E1 >: E, RIn2, ROut1 >: ROut, ROut2](that: ZLayer[RIn2, E1, ROut2])(implicit ev: UnionAll[ROut1, ROut2]): ZLayer[RIn with RIn2, E1, ROut1 with ROut2]
  5. final def ++[E1 >: E, RIn2, ROut1 >: ROut, ROut2](that: ZLayer[RIn2, E1, ROut2])(implicit ev: Union[ROut1, ROut2], tag: zio.Tag[ROut2]): ZLayer[RIn with RIn2, E1, ROut1 with ROut2]

    Combines this layer with the specified layer, producing a new layer that has the inputs of both layers, and the outputs of both layers.

  6. final def <&>[E1 >: E, RIn2, ROut2](that: ZLayer[RIn2, E1, ROut2]): ZLayer[RIn with RIn2, E1, (ROut, ROut2)]

    A symbolic alias for zipPar.

  7. def <>[RIn1 <: RIn, E1, ROut1 >: ROut](that: ZLayer[RIn1, E1, ROut1])(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut1]

    A symbolic alias for orElse.

  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def >+>[E1 >: E, RIn2 >: ROut, ROut1 >: ROut, ROut2](that: ZLayer[RIn2, E1, ROut2])(implicit ev: Union[ROut1, ROut2], tagged: zio.Tag[ROut2]): ZLayer[RIn, E1, ROut1 with ROut2]

    Feeds the output services of this layer into the input of the specified layer, resulting in a new layer with the inputs of this layer, and the outputs of both this layer and the specified layer.

  10. final def >>>[E1 >: E, ROut2](that: ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2]

    Feeds the output services of this layer into the input of the specified layer, resulting in a new layer with the inputs of this layer, and the outputs of the specified layer.

  11. final def and[E1 >: E, RIn2, ROut1 >: ROut, ROut2](that: ZLayer[RIn2, E1, ROut2])(implicit ev: Union[ROut1, ROut2], tagged: zio.Tag[ROut2]): ZLayer[RIn with RIn2, E1, ROut1 with ROut2]

    A named alias for ++.

  12. final def andTo[E1 >: E, RIn2 >: ROut, ROut1 >: ROut, ROut2](that: ZLayer[RIn2, E1, ROut2])(implicit ev: Union[ROut1, ROut2], tagged: zio.Tag[ROut2]): ZLayer[RIn, E1, ROut1 with ROut2]

    A named alias for >+>.

  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. final def build: ZManaged[RIn, E, ROut]

    Builds a layer into a managed value.

  15. final def catchAll[RIn1 <: RIn, E1, ROut1 >: ROut](handler: ZLayer[(RIn1, E), E1, ROut1]): ZLayer[RIn1, E1, ROut1]

    Recovers from all errors.

  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. final def flatMap[RIn1 <: RIn, E1 >: E, ROut2](f: (ROut) => ZLayer[RIn1, E1, ROut2]): ZLayer[RIn1, E1, ROut2]

    Constructs a layer dynamically based on the output of this layer.

  20. final def fold[E1, RIn1 <: RIn, ROut2](failure: ZLayer[(RIn1, Cause[E]), E1, ROut2], success: ZLayer[ROut, E1, ROut2])(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut2]

    Feeds the error or output services of this layer into the input of either the specified failure or success layers, resulting in a new layer with the inputs of this layer, and the error or outputs of the specified layer.

  21. final def fresh: ZLayer[RIn, E, ROut]

    Creates a fresh version of this layer that will not be shared.

  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  23. final lazy val hashCode: Int

    Returns the hash code of this layer.

    Returns the hash code of this layer.

    Definition Classes
    ZLayer → AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def launch(implicit ev: <:<[Any, RIn]): IO[E, Nothing]

    Builds this layer and uses it until it is interrupted.

    Builds this layer and uses it until it is interrupted. This is useful when your entire application is a layer, such as an HTTP server.

  26. final def map[ROut1](f: (ROut) => ROut1): ZLayer[RIn, E, ROut1]

    Returns a new layer whose output is mapped by the specified function.

  27. final def mapError[E1](f: (E) => E1)(implicit ev: CanFail[E]): ZLayer[RIn, E1, ROut]

    Returns a layer with its error channel mapped using the specified function.

  28. final def memoize: ZManaged[Any, Nothing, ZLayer[RIn, E, ROut]]

    Returns a managed effect that, if evaluated, will return the lazily computed result of this layer.

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. final def orDie(implicit ev1: <:<[E, Throwable], ev2: CanFail[E]): ZLayer[RIn, Nothing, ROut]

    Translates effect failure into death of the fiber, making all failures unchecked and not a part of the type of the layer.

  33. final def orElse[RIn1 <: RIn, E1, ROut1 >: ROut](that: ZLayer[RIn1, E1, ROut1])(implicit ev: CanFail[E]): ZLayer[RIn1, E1, ROut1]

    Executes this layer and returns its output, if it succeeds, but otherwise executes the specified layer.

  34. final def retry[RIn1 <: RIn with Clock](schedule: Schedule[RIn1, E, Any]): ZLayer[RIn1, E, ROut]

    Retries constructing this layer according to the specified schedule.

  35. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  36. final def tap[RIn1 <: RIn, E1 >: E](f: (ROut) => ZIO[RIn1, E1, Any]): ZLayer[RIn1, E1, ROut]

    Performs the specified effect if this layer succeeds.

  37. final def tapError[RIn1 <: RIn, E1 >: E](f: (E) => ZIO[RIn1, E1, Any]): ZLayer[RIn1, E1, ROut]

    Performs the specified effect if this layer fails.

  38. final def to[E1 >: E, ROut2](that: ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2]

    A named alias for >>>.

  39. final def toRuntime(p: Platform)(implicit ev: <:<[Any, RIn]): Managed[E, Runtime[ROut]]

    Converts a layer that requires no services into a managed runtime, which can be used to execute effects.

  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def update[A](f: (A) => A)(implicit arg0: zio.Tag[A], ev1: IsHas[ROut], ev2: <:<[ROut, Has[A]]): ZLayer[RIn, E, ROut]

    Updates one of the services output by this layer.

  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def zipPar[E1 >: E, RIn2, ROut2](that: ZLayer[RIn2, E1, ROut2]): ZLayer[RIn with RIn2, E1, (ROut, ROut2)]

    Combines this layer with the specified layer, producing a new layer that has the inputs of both layers, and the outputs of both layers combined into a tuple.

  46. final def zipWithPar[E1 >: E, RIn2, ROut1 >: ROut, ROut2, ROut3](that: ZLayer[RIn2, E1, ROut2])(f: (ROut, ROut2) => ROut3): ZLayer[RIn with RIn2, E1, ROut3]

    Combines this layer with the specified layer, producing a new layer that has the inputs of both layers, and the outputs of both layers combined using the specified function.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped