Fiber

Type Members

final case class Descriptor(id: FiberId.Runtime, status: Running, interrupters: Set[FiberId], executor: Executor, isLocked: Boolean) extends Product with Serializable

A record containing information about a Fiber.
A record containing information about a Fiber.
id
The fiber's unique identifier
interrupters
The set of fibers attempting to interrupt the fiber or its ancestors.
executor
The Executor executing this fiber
final case class Dump(fiberId: FiberId.Runtime, status: Status, trace: StackTrace) extends Product with Serializable
sealed abstract class Runtime[+E, +A] extends Fiber[E, A]

A runtime fiber that is executing an effect.
A runtime fiber that is executing an effect. Runtime fibers have an identity and a trace.
sealed trait Status extends AnyRef
sealed abstract class Synthetic[+E, +A] extends Fiber[E, A]

A synthetic fiber that is created from a pure value or that combines existing fibers.

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
object Status
final def asInstanceOf[T0]: T0

Definition Classes
Any
def awaitAll(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

Awaits on all fibers to be completed, successfully or not.
Awaits on all fibers to be completed, successfully or not.
fs
Iterable of fibers to be awaited
returns
UIO[Unit]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collectAll[E, A, Collection[+Element] <: Iterable[Element]](fibers: Collection[Fiber[E, A]])(implicit bf: zio.BuildFrom[Collection[Fiber[E, A]], A, Collection[A]]): Synthetic[E, Collection[A]]

Collects all fibers into a single fiber producing an in-order list of the results.
def collectAllDiscard[E, A](fibers: Iterable[Fiber[E, A]]): Synthetic[E, Unit]

Collects all fibers into a single fiber discarding their results.
def currentFiber()(implicit unsafe: Unsafe): Option[Fiber[Any, Any]]

Retrieves the fiber currently executing on this thread, if any.
Retrieves the fiber currently executing on this thread, if any. This will always be None unless called from within an executing effect and this feature is enabled using Runtime.enableCurrentFiber.
def done[E, A](exit: ⇒ Exit[E, A]): Synthetic[E, A]

A fiber that is done with the specified zio.Exit value.
A fiber that is done with the specified zio.Exit value.
E
error type
A
type of the fiber
exit
zio.Exit value
returns
Fiber[E, A]
def dumpAll(implicit trace: Trace): ZIO[Any, IOException, Unit]

Dumps all fibers to the console.
def dumpAllWith[R, E](f: (Dump) ⇒ ZIO[R, E, Any])(implicit trace: Trace): ZIO[R, E, Unit]

Dumps all fibers to the specified callback.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def fail[E](e: E): Synthetic[E, Nothing]

A fiber that has already failed with the specified value.
A fiber that has already failed with the specified value.
E
error type
e
failure value
returns
Fiber[E, Nothing] failed fiber
def failCause[E](cause: Cause[E]): Synthetic[E, Nothing]

Creates a Fiber that has already failed with the specified cause.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fromFuture[A](thunk: ⇒ Future[A])(implicit trace: Trace): Synthetic[Throwable, A]

Returns a Fiber that is backed by the specified Future.
Returns a Fiber that is backed by the specified Future.
A
type of the Fiber
thunk
Future[A] backing the Fiber
returns
Fiber[Throwable, A]
def fromZIO[E, A](io: IO[E, A])(implicit trace: Trace): UIO[Synthetic[E, A]]

Lifts an zio.ZIO into a Fiber.
Lifts an zio.ZIO into a Fiber.
E
error type
A
type of the fiber
io
IO[E, A] to turn into a Fiber
returns
UIO[Fiber[E, A]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def interruptAll(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

Interrupts all fibers, awaiting their interruption.
Interrupts all fibers, awaiting their interruption.
fs
Iterable of fibers to be interrupted
returns
UIO[Unit]
def interruptAllAs(fiberId: FiberId)(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

Interrupts all fibers as by the specified fiber, awaiting their interruption.
Interrupts all fibers as by the specified fiber, awaiting their interruption.
fiberId
The identity of the fiber to interrupt as.
fs
Iterable of fibers to be interrupted
returns
UIO[Unit]
def interruptAs(id: FiberId): Synthetic[Nothing, Nothing]

A fiber that is already interrupted.
A fiber that is already interrupted.
returns
Fiber[Nothing, Nothing] interrupted fiber
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def joinAll[E](fs: Iterable[Fiber[E, Any]])(implicit trace: Trace): IO[E, Unit]

Joins all fibers, awaiting their _successful_ completion.
Joins all fibers, awaiting their _successful_ completion. Attempting to join a fiber that has erred will result in a catchable error, _if_ that error does not result from interruption.
fs
Iterable of fibers to be joined
returns
UIO[Unit]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val never: Synthetic[Nothing, Nothing]

A fiber that never fails or succeeds.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def roots(implicit trace: Trace): UIO[Chunk[Runtime[_, _]]]

Returns a chunk containing all root fibers.
Returns a chunk containing all root fibers. Due to concurrency, the returned chunk is only weakly consistent.
def succeed[A](a: A): Synthetic[Nothing, A]

Returns a fiber that has already succeeded with the specified value.
Returns a fiber that has already succeeded with the specified value.
A
type of the fiber
a
success value
returns
Fiber[E, A] succeeded fiber
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val unit: Synthetic[Nothing, Unit]

A fiber that has already succeeded with unit.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class Fiber | package zio

object Fiber extends FiberPlatformSpecific

Type Members

final case class Descriptor(id: FiberId.Runtime, status: Running, interrupters: Set[FiberId], executor: Executor, isLocked: Boolean) extends Product with Serializable

final case class Dump(fiberId: FiberId.Runtime, status: Status, trace: StackTrace) extends Product with Serializable

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

sealed trait Status extends AnyRef

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

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Status

final def asInstanceOf[T0]: T0

def awaitAll(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

def clone(): AnyRef

def collectAll[E, A, Collection[+Element] <: Iterable[Element]](fibers: Collection[Fiber[E, A]])(implicit bf: zio.BuildFrom[Collection[Fiber[E, A]], A, Collection[A]]): Synthetic[E, Collection[A]]

def collectAllDiscard[E, A](fibers: Iterable[Fiber[E, A]]): Synthetic[E, Unit]

def currentFiber()(implicit unsafe: Unsafe): Option[Fiber[Any, Any]]

def done[E, A](exit: ⇒ Exit[E, A]): Synthetic[E, A]

def dumpAll(implicit trace: Trace): ZIO[Any, IOException, Unit]

def dumpAllWith[R, E](f: (Dump) ⇒ ZIO[R, E, Any])(implicit trace: Trace): ZIO[R, E, Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fail[E](e: E): Synthetic[E, Nothing]

def failCause[E](cause: Cause[E]): Synthetic[E, Nothing]

def finalize(): Unit

def fromFuture[A](thunk: ⇒ Future[A])(implicit trace: Trace): Synthetic[Throwable, A]

def fromZIO[E, A](io: IO[E, A])(implicit trace: Trace): UIO[Synthetic[E, A]]

final def getClass(): Class[_]

def hashCode(): Int

def interruptAll(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

def interruptAllAs(fiberId: FiberId)(fs: Iterable[Fiber[Any, Any]])(implicit trace: Trace): UIO[Unit]

def interruptAs(id: FiberId): Synthetic[Nothing, Nothing]

final def isInstanceOf[T0]: Boolean

def joinAll[E](fs: Iterable[Fiber[E, Any]])(implicit trace: Trace): IO[E, Unit]

final def ne(arg0: AnyRef): Boolean

val never: Synthetic[Nothing, Nothing]

final def notify(): Unit

final def notifyAll(): Unit

def roots(implicit trace: Trace): UIO[Chunk[Runtime[_, _]]]

def succeed[A](a: A): Synthetic[Nothing, A]

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

def toString(): String

val unit: Synthetic[Nothing, Unit]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from FiberPlatformSpecific

Inherited from AnyRef

Inherited from Any

Ungrouped