Packages

t

zio

ZIOCompanionVersionSpecific

trait ZIOCompanionVersionSpecific extends AnyRef

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZIOCompanionVersionSpecific
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def async[R, E, A](register: ((ZIO[R, E, A]) => Unit) => Unit, blockingOn: => FiberId = FiberId.None)(implicit trace: Trace): ZIO[R, E, A]

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    This method allows you to specify the fiber id that is responsible for invoking callbacks provided to the register function. This is called the "blocking fiber", because it is stopping the fiber executing the async effect from making progress (although it is not "blocking" a thread). Specifying this fiber id in cases where it is known will improve diagnostics, but not affect the behavior of the returned effect.

  6. def asyncInterrupt[R, E, A](register: ((ZIO[R, E, A]) => Unit) => Either[URIO[R, Any], ZIO[R, E, A]], blockingOn: => FiberId = FiberId.None)(implicit trace: Trace): ZIO[R, E, A]

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    With this variant, you can specify either a way to cancel the asynchrounous action, or you can return the result right away if no asynchronous operation is required.

    This method allows you to specify the fiber id that is responsible for invoking callbacks provided to the register function. This is called the "blocking fiber", because it is stopping the fiber executing the async effect from making progress (although it is not "blocking" a thread). Specifying this fiber id in cases where it is known will improve diagnostics, but not affect the behavior of the returned effect.

  7. def asyncMaybe[R, E, A](register: ((ZIO[R, E, A]) => Unit) => Option[ZIO[R, E, A]], blockingOn: => FiberId = FiberId.None)(implicit trace: Trace): ZIO[R, E, A]

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    Converts an asynchronous, callback-style API into a ZIO effect, which will be executed asynchronously.

    With this variant, the registration function may return the result right away, if it turns out that no asynchronous operation is required to complete the operation.

    This method allows you to specify the fiber id that is responsible for invoking callbacks provided to the register function. This is called the "blocking fiber", because it is stopping the fiber executing the async effect from making progress (although it is not "blocking" a thread). Specifying this fiber id in cases where it is known will improve diagnostics, but not affect the behavior of the returned effect.

  8. def attempt[A](code: => A)(implicit trace: Trace): Task[A]

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    This method should be used whenever you want to take arbitrary code, which may throw exceptions or not be type safe, and convert it into a ZIO effect, which can safely execute that code whenever the effect is executed.

    def printLine(line: String): Task[Unit] = ZIO.attempt(println(line))
  9. def attemptBlocking[A](effect: => A)(implicit trace: Trace): Task[A]

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    This method should be used whenever you want to take arbitrary code, which may throw exceptions or not be type safe, and convert it into a ZIO effect, which can safely execute that code whenever the effect is executed.

    This variant expects that the provided code will engage in blocking I/O, and therefore, pro-actively executes the code on a dedicated blocking thread pool, so it won't interfere with the main thread pool that ZIO uses.

  10. def attemptBlockingCancelable[R, A](effect: => A)(cancel: => URIO[R, Any])(implicit trace: Trace): RIO[R, A]

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    Returns an effect that, when executed, will cautiously run the provided code, catching any exception and translated it into a failed ZIO effect.

    This method should be used whenever you want to take arbitrary code, which may throw exceptions or not be type safe, and convert it into a ZIO effect, which can safely execute that code whenever the effect is executed.

    This variant expects that the provided code will engage in blocking I/O, and therefore, pro-actively executes the code on a dedicated blocking thread pool, so it won't interfere with the main thread pool that ZIO uses.

    Additionally, this variant allows you to specify an effect that will cancel the blocking operation. This effect will be executed if the fiber that is executing the blocking effect is interrupted for any reason.

  11. def attemptBlockingIO[A](effect: => A)(implicit trace: Trace): IO[IOException, A]

    This function is the same as attempt, except that it only exposes IOException, treating any other exception as fatal.

  12. final def attemptOrDieZIO[R, E, A](effect: => ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Wraps the provided effect in a catch-try block.

    Wraps the provided effect in a catch-try block. Useful for handling cases where the user-provided effect might throw outside the ZIO effect, but we don't want to incur the performance penalty from the additional flatMap in ZIO.suspend.

    Attributes
    protected
    Annotations
    @inline()
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def ignore(code: => Any)(implicit trace: Trace): UIO[Unit]

    Returns an effect that, when executed, will cautiously run the provided code, ignoring it success or failure.

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def succeed[A](a: => A)(implicit trace: Trace): ZIO[Any, Nothing, A]

    Returns an effect that models success with the specified value.

  24. def succeedBlocking[A](a: => A)(implicit trace: Trace): UIO[A]

    Returns a synchronous effect that does blocking and succeeds with the specified value.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped