object CancelableF
- Alphabetic
- By Inheritance
- CancelableF
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
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
-
def
apply[F[_]](token: F[Unit])(implicit F: Sync[F]): F[CancelableF[F]]
Given a token that does not guarantee idempotency, wraps it in a CancelableF value that guarantees the given token will execute only once.
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
cancelAll[F[_]](seq: CancelableF[F]*)(implicit F: Sync[F]): CancelToken[F]
Given a collection of cancelables, creates a token that on evaluation will cancel them all.
Given a collection of cancelables, creates a token that on evaluation will cancel them all.
This function collects non-fatal exceptions and throws them all at the end as a composite, in a platform specific way:
- for the JVM "Suppressed Exceptions" are used
- for JS they are wrapped in a
CompositeException
-
def
cancelAllTokens[F[_]](seq: CancelToken[F]*)(implicit F: Sync[F]): CancelToken[F]
Given a collection of cancel tokens, creates a token that on evaluation will cancel them all.
Given a collection of cancel tokens, creates a token that on evaluation will cancel them all.
This function collects non-fatal exceptions and throws them all at the end as a composite, in a platform specific way:
- for the JVM "Suppressed Exceptions" are used
- for JS they are wrapped in a
CompositeException
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
collection[F[_]](refs: CancelableF[F]*)(implicit F: Sync[F]): CancelableF[F]
Builds a CancelableF reference from a sequence, cancelling everything when
cancel
gets evaluated. -
def
empty[F[_]](implicit F: Applicative[F]): CancelableF[F]
Returns a dummy CancelableF that doesn't do anything.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.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
-
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
-
def
unsafeApply[F[_]](token: F[Unit])(implicit F: Sync[F]): CancelableF[F]
Unsafe version of apply.
Unsafe version of apply.
This function is unsafe because creating the returned BooleanCancelableF allocates internal shared mutable state, thus breaking referential transparency, which can catch users by surprise.
- Annotations
- @UnsafeBecauseImpure()
-
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
- @native() @throws( ... )
-
def
wrap[F[_]](token: CancelToken[F]): CancelableF[F]
Wraps a cancellation token into a CancelableF instance.
Wraps a cancellation token into a CancelableF instance.
Compared with apply the returned value does not guarantee idempotency.
N.B. the returned result is as pure as the wrapped result. Since we aren't allocating mutable internal state for creating this value, we don't need to return the value in
F[_]
, like in apply.