Fiber

Companion object Fiber

abstract class Fiber[+E, +A] extends AnyRef

A fiber is a lightweight thread of execution that never consumes more than a whole thread (but may consume much less, depending on contention and asynchronicity). Fibers are spawned by forking ZIO effects, which run concurrently with the parent effect.

Fibers can be joined, yielding their result to other fibers, or interrupted, which terminates the fiber, safely releasing all resources.

def parallel[A, B](io1: Task[A], io2: Task[B]): Task[(A, B)] =
  for {
    fiber1 <- io1.fork
    fiber2 <- io2.fork
    a      <- fiber1.join
    b      <- fiber2.join
  } yield (a, b)

Self Type: Fiber[E, A]

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Fiber
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Fiber()

Abstract Value Members

abstract def await(implicit trace: Trace): 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]]
abstract def children(implicit trace: Trace): UIO[Chunk[Fiber.Runtime[_, _]]]
Retrieves the immediate children of the fiber.
abstract def id: FiberId
The identity of the fiber.
abstract def inheritAll(implicit trace: Trace): 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]
abstract def interruptAsFork(fiberId: FiberId)(implicit trace: Trace): UIO[Unit]
In the background, interrupts the fiber as if interrupted from the specified fiber.
In the background, 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]]
abstract def poll(implicit trace: Trace): 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]]]

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
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
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
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
final def <+>[E1 >: E, B](that: => Fiber[E1, B])(implicit ev: CanFail[E]): Synthetic[E1, Either[A, B]]
A symbolic alias for orElseEither.
def <>[E1, A1 >: A](that: => Fiber[E1, A1])(implicit ev: CanFail[E]): Synthetic[E1, A1]
A symbolic alias for orElse.
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
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
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
final def fold[Z](runtime: (Fiber.Runtime[E, A]) => Z, synthetic: (Synthetic[E, A]) => Z): Z
Folds over the runtime or synthetic fiber.
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def interrupt(implicit trace: Trace): 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]]
final def interruptAs(fiberId: FiberId)(implicit trace: Trace): 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]]
final def interruptFork(implicit trace: Trace): 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]
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def join(implicit trace: Trace): 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]
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
final def mapFiber[E1 >: E, B](f: (A) => Fiber[E1, B])(implicit trace: Trace): 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.
final def mapZIO[E1 >: E, B](f: (A) => IO[E1, B]): Synthetic[E1, B]
Effectually maps over the value the fiber computes.
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
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]
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]
final def scoped(implicit trace: Trace): ZIO[Scope, Nothing, Fiber[E, A]]
Converts this fiber into a scoped zio.ZIO.
Converts this fiber into a scoped zio.ZIO. The fiber is interrupted when the scope is closed.
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
final def toFuture(implicit ev: IsSubtypeOfError[E, Throwable], trace: Trace): 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]]
final def toFutureWith(f: (E) => Throwable)(implicit trace: Trace): 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]]
def toString(): String
Definition Classes
AnyRef → Any
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 ()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
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
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
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
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

Deprecated Value Members

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

Packages

Fiber

Companion object Fiber

abstract class Fiber[+E, +A] extends AnyRef

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Fiber

Companion object Fiber

abstract class Fiber[+E, +A] extends AnyRef

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Fiber