abstract class TryableDeferred[F[_], A] extends Deferred[F, A]
- Source
- Deferred.scala
- Alphabetic
- By Inheritance
- TryableDeferred
- Deferred
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new TryableDeferred()
Abstract Value Members
-
abstract
def
complete(a: A): F[Unit]
If this
Deferred
is empty, sets the current value toa
, and notifies any and all readers currently blocked on aget
.If this
Deferred
is empty, sets the current value toa
, and notifies any and all readers currently blocked on aget
.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 anIllegalStateException
. In the uncommon scenario where this behavior is problematic, you can handle failure explicitly usingattempt
or any otherApplicativeError
/MonadError
combinator on the returned action.Satisfies:
Deferred[F, A].flatMap(r => r.complete(a) *> r.get) == a.pure[F]
- Definition Classes
- Deferred
-
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
-
abstract
def
tryGet: F[Option[A]]
Obtains the current value of the
Deferred
, or None if it hasn't completed.
Concrete 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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
mapK[G[_]](f: ~>[F, G]): Deferred[G, A]
Modify the context
F
using transformationf
.Modify the context
F
using transformationf
.- Definition Classes
- Deferred
-
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()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... ) @native()
This is the API documentation for the cats-effect library.
See the cats.effect package for a quick overview.
Links
Canonical documentation links:
Related Cats links (the core):