Packages

c

zio.Fiber

Runtime

sealed abstract class Runtime[+E, +A] extends Fiber[E, A]

A runtime fiber that is executing an effect. Runtime fibers have an identity and a trace.

Self Type
Runtime[E, A]
Linear Supertypes
Fiber[E, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Runtime
  2. Fiber
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def await(implicit trace: ZTraceElement): UIO[Exit[E, A]]

    Awaits the fiber, which suspends the awaiting fiber until the result of the fiber has been determined.

    Awaits the fiber, which suspends the awaiting fiber until the result of the fiber has been determined.

    returns

    UIO[Exit[E, A]]

    Definition Classes
    Fiber
  2. abstract def getRef[A](ref: ZFiberRef.Runtime[A])(implicit trace: ZTraceElement): UIO[A]

    Gets the value of the fiber ref for this fiber, or the initial value of the fiber ref, if the fiber is not storing the ref.

    Gets the value of the fiber ref for this fiber, or the initial value of the fiber ref, if the fiber is not storing the ref.

    Definition Classes
    Fiber
  3. abstract def id: FiberId.Runtime

    The identity of the fiber.

  4. abstract def inheritRefs(implicit trace: ZTraceElement): UIO[Unit]

    Inherits values from all FiberRef instances into current fiber.

    Inherits values from all FiberRef instances into current fiber. This will resume immediately.

    returns

    UIO[Unit]

    Definition Classes
    Fiber
  5. abstract def interruptAs(fiberId: FiberId)(implicit trace: ZTraceElement): UIO[Exit[E, A]]

    Interrupts the fiber as if interrupted from the specified fiber.

    Interrupts the fiber as if interrupted from the specified fiber. If the fiber has already exited, the returned effect will resume immediately. Otherwise, the effect will resume when the fiber exits.

    returns

    UIO[Exit, E, A]]

    Definition Classes
    Fiber
  6. abstract def poll(implicit trace: ZTraceElement): UIO[Option[Exit[E, A]]]

    Tentatively observes the fiber, but returns immediately if it is not already done.

    Tentatively observes the fiber, but returns immediately if it is not already done.

    returns

    UIO[Option[Exit, E, A]]]

    Definition Classes
    Fiber
  7. abstract def scope: ZScope[Exit[E, A]]
  8. abstract def status(implicit trace: ZTraceElement): UIO[Status]

    The status of the fiber.

  9. abstract def trace(implicit trace: ZTraceElement): UIO[ZTrace]

    The trace of the fiber.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def *>[E1 >: E, B](that: Fiber[E1, B]): Synthetic[E1, B]

    Same as zip but discards the output of the left hand side.

    Same as zip but discards the output of the left hand side.

    E1

    error type

    B

    type of the fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, B] combined fiber

    Definition Classes
    Fiber
  4. final def <*[E1 >: E, B](that: Fiber[E1, B]): Synthetic[E1, A]

    Same as zip but discards the output of the right hand side.

    Same as zip but discards the output of the right hand side.

    E1

    error type

    B

    type of the fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, A] combined fiber

    Definition Classes
    Fiber
  5. final def <*>[E1 >: E, B](that: => Fiber[E1, B])(implicit zippable: Zippable[A, B]): Synthetic[E1, Out]

    Zips this fiber and the specified fiber together, producing a tuple of their output.

    Zips this fiber and the specified fiber together, producing a tuple of their output.

    E1

    error type

    B

    type of that fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, (A, B)] combined fiber

    Definition Classes
    Fiber
  6. final def <+>[E1 >: E, B](that: => Fiber[E1, B])(implicit ev: CanFail[E]): Synthetic[E1, Either[A, B]]

    A symbolic alias for orElseEither.

    A symbolic alias for orElseEither.

    Definition Classes
    Fiber
  7. def <>[E1, A1 >: A](that: => Fiber[E1, A1])(implicit ev: CanFail[E]): Synthetic[E1, A1]

    A symbolic alias for orElse.

    A symbolic alias for orElse.

    Definition Classes
    Fiber
  8. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def as[B](b: => B): Synthetic[E, B]

    Maps the output of this fiber to the specified constant.

    Maps the output of this fiber to the specified constant.

    B

    type of the fiber

    b

    constant

    returns

    Fiber[E, B] fiber mapped to constant

    Definition Classes
    Fiber
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  12. final def dump(implicit trace: ZTraceElement): UIO[Dump]

    Generates a fiber dump with optionally excluded stack traces.

  13. final def dumpWith(withTrace: Boolean)(implicit trace: ZTraceElement): UIO[Dump]

    Generates a fiber dump.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def fold[Z](runtime: (Runtime[E, A]) => Z, synthetic: (Synthetic[E, A]) => Z): Z

    Folds over the runtime or synthetic fiber.

    Folds over the runtime or synthetic fiber.

    Definition Classes
    Fiber
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def interrupt(implicit trace: ZTraceElement): UIO[Exit[E, A]]

    Interrupts the fiber from whichever fiber is calling this method.

    Interrupts the fiber from whichever fiber is calling this method. If the fiber has already exited, the returned effect will resume immediately. Otherwise, the effect will resume when the fiber exits.

    returns

    UIO[Exit, E, A]]

    Definition Classes
    Fiber
  21. final def interruptFork(implicit trace: ZTraceElement): UIO[Unit]

    Interrupts the fiber from whichever fiber is calling this method.

    Interrupts the fiber from whichever fiber is calling this method. The interruption will happen in a separate daemon fiber, and the returned effect will always resume immediately without waiting.

    returns

    UIO[Unit]

    Definition Classes
    Fiber
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def join(implicit trace: ZTraceElement): IO[E, A]

    Joins the fiber, which suspends the joining fiber until the result of the fiber has been determined.

    Joins the fiber, which suspends the joining fiber until the result of the fiber has been determined. Attempting to join a fiber that has erred will result in a catchable error. Joining an interrupted fiber will result in an "inner interruption" of this fiber, unlike interruption triggered by another fiber, "inner interruption" can be caught and recovered.

    returns

    IO[E, A]

    Definition Classes
    Fiber
  24. final def map[B](f: (A) => B): Synthetic[E, B]

    Maps over the value the Fiber computes.

    Maps over the value the Fiber computes.

    B

    result type of f

    f

    mapping function

    returns

    Fiber[E, B] mapped fiber

    Definition Classes
    Fiber
  25. final def mapFiber[E1 >: E, B](f: (A) => Fiber[E1, B])(implicit trace: ZTraceElement): UIO[Fiber[E1, B]]

    Passes the success of this fiber to the specified callback, and continues with the fiber that it returns.

    Passes the success of this fiber to the specified callback, and continues with the fiber that it returns.

    B

    The success value.

    f

    The callback.

    returns

    Fiber[E, B] The continued fiber.

    Definition Classes
    Fiber
  26. final def mapZIO[E1 >: E, B](f: (A) => IO[E1, B]): Synthetic[E1, B]

    Effectually maps over the value the fiber computes.

    Effectually maps over the value the fiber computes.

    Definition Classes
    Fiber
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def orElse[E1, A1 >: A](that: => Fiber[E1, A1])(implicit ev: CanFail[E]): Synthetic[E1, A1]

    Returns a fiber that prefers this fiber, but falls back to the that one when this one fails.

    Returns a fiber that prefers this fiber, but falls back to the that one when this one fails. Interrupting the returned fiber will interrupt both fibers, sequentially, from left to right.

    E1

    error type

    A1

    type of the other fiber

    that

    fiber to fall back to

    returns

    Fiber[E1, A1]

    Definition Classes
    Fiber
  31. final def orElseEither[E1, B](that: => Fiber[E1, B]): Synthetic[E1, Either[A, B]]

    Returns a fiber that prefers this fiber, but falls back to the that one when this one fails.

    Returns a fiber that prefers this fiber, but falls back to the that one when this one fails. Interrupting the returned fiber will interrupt both fibers, sequentially, from left to right.

    E1

    error type

    B

    type of the other fiber

    that

    fiber to fall back to

    returns

    Fiber[E1, B]

    Definition Classes
    Fiber
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. final def toFuture(implicit ev: IsSubtypeOfError[E, Throwable], trace: ZTraceElement): UIO[CancelableFuture[A]]

    Converts this fiber into a scala.concurrent.Future.

    Converts this fiber into a scala.concurrent.Future.

    ev

    implicit witness that E is a subtype of Throwable

    returns

    UIO[Future[A]]

    Definition Classes
    Fiber
  34. final def toFutureWith(f: (E) => Throwable)(implicit trace: ZTraceElement): UIO[CancelableFuture[A]]

    Converts this fiber into a scala.concurrent.Future, translating any errors to java.lang.Throwable with the specified conversion function, using Cause.squashTraceWith

    Converts this fiber into a scala.concurrent.Future, translating any errors to java.lang.Throwable with the specified conversion function, using Cause.squashTraceWith

    f

    function to the error into a Throwable

    returns

    UIO[Future[A]]

    Definition Classes
    Fiber
  35. final def toManaged(implicit trace: ZTraceElement): ZManaged[Any, Nothing, Fiber[E, A]]

    Converts this fiber into a zio.ZManaged.

    Converts this fiber into a zio.ZManaged. Fiber is interrupted on release.

    returns

    ZManaged[Any, Nothing, Fiber[E, A]]

    Definition Classes
    Fiber
  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. final def unit: Synthetic[E, Unit]

    Maps the output of this fiber to ().

    Maps the output of this fiber to ().

    returns

    Fiber[E, Unit] fiber mapped to ()

    Definition Classes
    Fiber
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def zip[E1 >: E, B](that: => Fiber[E1, B])(implicit zippable: Zippable[A, B]): Synthetic[E1, Out]

    Named alias for <*>.

    Named alias for <*>.

    E1

    error type

    B

    type of that fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, (A, B)] combined fiber

    Definition Classes
    Fiber
  42. final def zipLeft[E1 >: E, B](that: Fiber[E1, B]): Synthetic[E1, A]

    Named alias for <*.

    Named alias for <*.

    E1

    error type

    B

    type of the fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, A] combined fiber

    Definition Classes
    Fiber
  43. final def zipRight[E1 >: E, B](that: Fiber[E1, B]): Synthetic[E1, B]

    Named alias for *>.

    Named alias for *>.

    E1

    error type

    B

    type of the fiber

    that

    fiber to be zipped

    returns

    Fiber[E1, B] combined fiber

    Definition Classes
    Fiber
  44. final def zipWith[E1 >: E, B, C](that: => Fiber[E1, B])(f: (A, B) => C): Synthetic[E1, C]

    Zips this fiber with the specified fiber, combining their results using the specified combiner function.

    Zips this fiber with the specified fiber, combining their results using the specified combiner function. Both joins and interruptions are performed in sequential order from left to right.

    E1

    error type

    B

    type of that fiber

    C

    type of the resulting fiber

    that

    fiber to be zipped

    f

    function to combine the results of both fibers

    returns

    Fiber[E1, C] combined fiber

    Definition Classes
    Fiber

Deprecated Value Members

  1. final def mapM[E1 >: E, B](f: (A) => IO[E1, B]): Synthetic[E1, B]

    Effectually maps over the value the fiber computes.

    Effectually maps over the value the fiber computes.

    Definition Classes
    Fiber
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) use mapZIO

Inherited from Fiber[E, A]

Inherited from AnyRef

Inherited from Any

Ungrouped