Packages

object SyncIO extends SyncIOCompanionPlatform with SyncIOLowPriorityImplicits with Serializable

Source
SyncIO.scala
Linear Supertypes
Serializable, SyncIOLowPriorityImplicits, SyncIOCompanionPlatform, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncIO
  2. Serializable
  3. SyncIOLowPriorityImplicits
  4. SyncIOCompanionPlatform
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class SyncIOSemigroup[A] extends kernel.Semigroup[SyncIO[A]]
    Attributes
    protected
    Definition Classes
    SyncIOLowPriorityImplicits

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. implicit def alignForSyncIO: Align[SyncIO]
  5. def apply[A](thunk: => A): SyncIO[A]

    Suspends a synchronous side effect in SyncIO.

    Suspends a synchronous side effect in SyncIO.

    Any exceptions thrown by the effect will be caught and sequenced into the SyncIO.

    thunk

    side effectful expression to be suspended in SyncIO

    returns

    a SyncIO that will be evaluated to the side effectful expression thunk

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def defer[A](thunk: => SyncIO[A]): SyncIO[A]

    Suspends a synchronous side effect which produces a SyncIO in SyncIO.

    Suspends a synchronous side effect which produces a SyncIO in SyncIO.

    This is useful for trampolining (i.e. when the side effect is conceptually the allocation of a stack frame). Any exceptions thrown by the side effect will be caught and sequenced into the SyncIO.

    thunk

    SyncIO expression to be suspended in SyncIO

    returns

    a SyncIO that will be evaluated to the value of the suspended thunk

  9. def delay[A](thunk: => A): SyncIO[A]

    Alias for apply.

    Alias for apply.

    See also

    SyncIO.apply

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def eval[A](fa: Eval[A]): SyncIO[A]

    Lifts an Eval into SyncIO.

    Lifts an Eval into SyncIO.

    This function will preserve the evaluation semantics of any actions that are lifted into the pure SyncIO. Eager Eval instances will be converted into thunk-less SyncIO (i.e. eager SyncIO), while lazy eval and memoized will be executed as such.

    fa

    Eval instance to be lifted in SyncIO

    returns

    SyncIO that will be evaluated to the value of the lifted fa

  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def fromEither[A](e: Either[Throwable, A]): SyncIO[A]

    Lifts an Either[Throwable, A] into SyncIO, raising the throwable if it exists.

    Lifts an Either[Throwable, A] into SyncIO, raising the throwable if it exists.

    e

    either value to be lifted

    returns

    SyncIO that evaluates to the value of e or fail with its Throwable instance

  15. def fromOption[A](o: Option[A])(orElse: => Throwable): SyncIO[A]

    Lifts an Option[A] into SyncIO, raising orElse if the provided option value is empty.

    Lifts an Option[A] into SyncIO, raising orElse if the provided option value is empty.

    o

    option value to be lifted

    orElse

    expression that evaluates to Throwable

    returns

    SyncIO that evaluates to the optional value o or fail with the orElse expression

  16. def fromTry[A](t: Try[A]): SyncIO[A]

    Lifts a Try[A] into SyncIO, raising the throwable if it exists.

    Lifts a Try[A] into SyncIO, raising the throwable if it exists.

    t

    try value to be lifted

    returns

    SyncIO that evaluates to the value of t if successful, or fails with its Throwable instance

  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. implicit def monoidForIO[A](implicit arg0: kernel.Monoid[A]): kernel.Monoid[SyncIO[A]]
  21. val monotonic: SyncIO[FiniteDuration]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def pure[A](value: A): SyncIO[A]

    Suspends a pure value in SyncIO.

    Suspends a pure value in SyncIO.

    This should only be used if the value in question has "already" been computed! In other words, something like SyncIO.pure(readLine) is most definitely not the right thing to do! However, SyncIO.pure(42) is correct and will be more efficient (when evaluated) than SyncIO(42), due to avoiding the allocation of extra thunks.

    value

    precomputed value used as the result of the SyncIO

    returns

    an already evaluated SyncIO holding value

  26. def raiseError[A](t: Throwable): SyncIO[A]

    Constructs a SyncIO which sequences the specified exception.

    Constructs a SyncIO which sequences the specified exception.

    If this SyncIO is run using unsafeRunSync the exception will be thrown. This exception can be "caught" (or rather, materialized into value-space) using the attempt method.

    t

    Throwable value to fail with

    returns

    a SyncIO that results in failure with value t

    See also

    SyncIO#attempt

  27. val realTime: SyncIO[FiniteDuration]
  28. final def realTimeInstant: SyncIO[Instant]
    Definition Classes
    SyncIOCompanionPlatform
  29. implicit def semigroupForIO[A](implicit arg0: kernel.Semigroup[A]): kernel.Semigroup[SyncIO[A]]
    Definition Classes
    SyncIOLowPriorityImplicits
  30. implicit def showForSyncIO[A](implicit A: Show[A]): Show[SyncIO[A]]
  31. implicit def syncForSyncIO: Sync[SyncIO] with MonadCancel[SyncIO, Throwable]
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def unit: SyncIO[Unit]

    Alias for SyncIO.pure(())

    Alias for SyncIO.pure(())

    See also

    SyncIO.pure

  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from SyncIOLowPriorityImplicits

Inherited from SyncIOCompanionPlatform

Inherited from AnyRef

Inherited from Any

Ungrouped