Packages

c

cats.effect.concurrent

TryableDeferred

abstract class TryableDeferred[F[_], A] extends Deferred[F, A]

Source
Deferred.scala
Linear Supertypes
Deferred[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TryableDeferred
  2. Deferred
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new TryableDeferred()

Abstract Value Members

  1. abstract def complete(a: A): F[Unit]

    If this Deferred is empty, sets the current value to a, and notifies any and all readers currently blocked on a get.

    If this Deferred is empty, sets the current value to a, and notifies any and all readers currently blocked on a get.

    Note that the returned action may complete after the reference has been successfully set: use F.start(r.complete) if you want asynchronous behaviour.

    If this Deferred has already been completed, the returned action immediately fails with an IllegalStateException. In the uncommon scenario where this behavior is problematic, you can handle failure explicitly using attempt or any other ApplicativeError/MonadError combinator on the returned action.

    Satisfies: Deferred[F, A].flatMap(r => r.complete(a) *> r.get) == a.pure[F]

    Definition Classes
    Deferred
  2. abstract def get: F[A]

    Obtains the value of the Deferred, or waits until it has been completed.

    Obtains the value of the Deferred, or waits until it has been completed. The returned value may be canceled.

    Definition Classes
    Deferred
  3. abstract def tryGet: F[Option[A]]

    Obtains the current value of the Deferred, or None if it hasn't completed.

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def mapK[G[_]](f: ~>[F, G]): Deferred[G, A]

    Modify the context F using transformation f.

    Modify the context F using transformation f.

    Definition Classes
    Deferred
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from Deferred[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped