Class/Object

zio

ZLayer

Related Docs: object ZLayer | package zio

Permalink

final 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
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZLayer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def >>>[E1 >: E, ROut2](that: ZLayer[ROut, E1, ROut2]): ZLayer[RIn, E1, ROut2]

    Permalink

    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.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def build: ZManaged[RIn, E, ROut]

    Permalink

    Builds a layer into a managed value.

  7. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def fold[E1, ROut2](failure: ZLayer[Cause[E], E1, ROut2], success: ZLayer[ROut, E1, ROut2])(implicit ev: CanFail[E]): ZLayer[RIn, E1, ROut2]

    Permalink

    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.

  12. def fresh: ZLayer[RIn, E, ROut]

    Permalink

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

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  16. def map[ROut1](f: (ROut) ⇒ ROut1): ZLayer[RIn, E, ROut1]

    Permalink

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

  17. def mapError[E1](f: (E) ⇒ E1)(implicit ev: CanFail[E]): ZLayer[RIn, E1, ROut]

    Permalink

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

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

    Permalink

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

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def orDie(implicit ev1: <:<[E, Throwable], ev2: CanFail[E]): ZLayer[RIn, Nothing, ROut]

    Permalink

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

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

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  25. def toRuntime(p: Platform)(implicit ev: <:<[Any, RIn]): Managed[E, Runtime[ROut]]

    Permalink

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

  26. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def zipWithPar[E1 >: E, RIn2, ROut1 >: ROut, ROut2, ROut3](that: ZLayer[RIn2, E1, ROut2])(f: (ROut, ROut2) ⇒ ROut3): ZLayer[RIn with RIn2, E1, ROut3]

    Permalink

    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.

Inherited from AnyRef

Inherited from Any

Ungrouped