Object/Class

cats.effect

SyncIO

Related Docs: class SyncIO | package effect

Permalink

object SyncIO extends SyncIOInstances

Source
SyncIO.scala
Linear Supertypes
SyncIOInstances, SyncIOLowPriorityInstances, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyncIO
  2. SyncIOInstances
  3. SyncIOLowPriorityInstances
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply[A](thunk: ⇒ A): SyncIO[A]

    Permalink

    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.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def eval[A](fa: Eval[A]): SyncIO[A]

    Permalink

    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.

  10. def finalize(): Unit

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

    Permalink

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

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def pure[A](a: A): SyncIO[A]

    Permalink

    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.

  19. def raiseError[A](e: Throwable): SyncIO[A]

    Permalink

    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.

    See also

    SyncIO#attempt

  20. def suspend[A](thunk: ⇒ SyncIO[A]): SyncIO[A]

    Permalink

    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.

  21. implicit def syncIoMonoid[A](implicit arg0: Monoid[A]): Monoid[SyncIO[A]]

    Permalink
    Definition Classes
    SyncIOInstances
  22. implicit def syncIoSemigroup[A](implicit arg0: Semigroup[A]): Semigroup[SyncIO[A]]

    Permalink
    Definition Classes
    SyncIOLowPriorityInstances
  23. implicit val syncIoSemigroupK: SemigroupK[SyncIO]

    Permalink
    Definition Classes
    SyncIOInstances
  24. implicit val syncIoSync: Sync[SyncIO]

    Permalink
    Definition Classes
    SyncIOInstances
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. val unit: SyncIO[Unit]

    Permalink

    Alias for SyncIO.pure(()).

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SyncIOInstances

Inherited from SyncIOLowPriorityInstances

Inherited from AnyRef

Inherited from Any

Ungrouped