Packages

object Coeval extends CoevalInstancesLevel0 with Serializable

Coeval builders.

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

Type Members

  1. final case class Always[+A](f: () ⇒ A) extends Coeval[A] with Product with Serializable

    Constructs a lazy Coeval instance.

    Constructs a lazy Coeval instance.

    This type can be used for "lazy" values. In some sense it is equivalent to using a Function0 value.

  2. sealed abstract class Eager[+A] extends Coeval[A] with Product

    The Eager type represents a strict, already evaluated result of a Coeval that either resulted in success, wrapped in a Now, or in an error, wrapped in an Error.

    The Eager type represents a strict, already evaluated result of a Coeval that either resulted in success, wrapped in a Now, or in an error, wrapped in an Error.

    It's the moral equivalent of scala.util.Try, except that application of functions such as map and flatMap produces Coeval references that are still lazily evaluated.

  3. final case class Error(error: Throwable) extends Eager[Nothing] with Product with Serializable

    Constructs an eager Coeval instance for a result that represents an error.

  4. final case class Now[+A](a: A) extends Eager[A] with Product with Serializable

    Constructs an eager Coeval instance from a strict value that's already known.

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. def apply[A](f: ⇒ A): Coeval[A]

    Promotes a non-strict value to a Coeval.

    Promotes a non-strict value to a Coeval.

    Alias of eval.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. implicit def catsMonoid[A](implicit A: Monoid[A]): Monoid[Coeval[A]]

    Given an A type that has a cats.Monoid[A] implementation, then this provides the evidence that Coeval[A] also has a Monoid[Coeval[A]] implementation.

  7. implicit def catsSemigroup[A](implicit A: Semigroup[A]): Semigroup[Coeval[A]]

    Given an A type that has a cats.Semigroup[A] implementation, then this provides the evidence that Coeval[A] also has a Semigroup[Coeval[A]] implementation.

    Given an A type that has a cats.Semigroup[A] implementation, then this provides the evidence that Coeval[A] also has a Semigroup[Coeval[A]] implementation.

    This has a lower-level priority than Coeval.catsMonoid in order to avoid conflicts.

    Definition Classes
    CoevalInstancesLevel0
  8. implicit def catsSync: CatsSyncForCoeval

    Instance of Cats type classes for Coeval, implementing cats.effect.Sync (which implies Applicative, Monad, MonadError) and cats.CoflatMap.

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. def defer[A](fa: ⇒ Coeval[A]): Coeval[A]

    Promote a non-strict value representing a Coeval to a Coeval of the same type.

  11. def delay[A](a: ⇒ A): Coeval[A]

    Alias for eval.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def eval[A](a: ⇒ A): Coeval[A]

    Promote a non-strict value to a Coeval, catching exceptions in the process.

    Promote a non-strict value to a Coeval, catching exceptions in the process.

    Note that since Coeval is not memoized, this will recompute the value each time the Coeval is executed.

  15. def evalOnce[A](a: ⇒ A): Coeval[A]

    Promote a non-strict value to a Coeval that is memoized on the first evaluation, the result being then available on subsequent evaluations.

    Promote a non-strict value to a Coeval that is memoized on the first evaluation, the result being then available on subsequent evaluations.

    Guarantees thread-safe idempotency.

    UNSAFE — this operation allocates a shared, mutable reference, which can break in certain cases referential transparency, even if this operation guarantees idempotency (i.e. referential transparency implies idempotency, but idempotency does not imply referential transparency).

    The allocation of a mutable reference is known to be a side effect, thus breaking referential transparency, even if calling this method does not trigger the evaluation of side effects suspended by the source.

    Use with care. Sometimes it's easier to just keep a shared, memoized reference to some connection, but keep in mind it might be better to pass such a reference around as a parameter.

  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def from[F[_], A](fa: F[A])(implicit F: CoevalLike[F]): Coeval[A]

    Converts any value that has a CoevalLike instance into a Coeval.

  18. def fromEither[E, A](f: (E) ⇒ Throwable)(a: Either[E, A]): Coeval[A]

    Converts a Scala Either into a Coeval.

    Converts a Scala Either into a Coeval.

    f

    is a function that knows how to convert into a Throwable in order to throw that error in the MonadError context.

  19. def fromEither[E <: Throwable, A](a: Either[E, A]): Coeval[A]

    Converts a Scala Either into a Coeval.

  20. def fromEval[A](a: Eval[A]): Coeval[A]

    Converts a cats.Eval into a Coeval.

  21. def fromSyncIO[A](a: SyncIO[A]): Coeval[A]

    Converts a cats.effect.SyncIO into a Coeval.

  22. def fromTry[A](a: Try[A]): Coeval[A]

    Converts a Scala Try into a Coeval.

  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def map2[A1, A2, R](fa1: Coeval[A1], fa2: Coeval[A2])(f: (A1, A2) ⇒ R): Coeval[R]

    Pairs 2 Coeval values, applying the given mapping function.

    Pairs 2 Coeval values, applying the given mapping function.

    Returns a new Coeval reference that completes with the result of mapping that function to their successful results, or in failure in case either of them fails.

    val fa1 = Coeval(1)
    val fa2 = Coeval(2)
    
    // Yields Success(3)
    Coeval.map2(fa1, fa2) { (a, b) =>
      a + b
    }
    
    // Yields Failure(e), because the second arg is a failure
    Coeval.map2(fa1, Coeval.raiseError[Int](new RuntimeException("boo"))) { (a, b) =>
      a + b
    }
  27. def map3[A1, A2, A3, R](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3])(f: (A1, A2, A3) ⇒ R): Coeval[R]

    Pairs 3 Coeval values, applying the given mapping function.

    Pairs 3 Coeval values, applying the given mapping function.

    Returns a new Coeval reference that completes with the result of mapping that function to their successful results, or in failure in case either of them fails.

    val fa1 = Coeval(1)
    val fa2 = Coeval(2)
    val fa3 = Coeval(3)
    
    // Yields Success(6)
    Coeval.map3(fa1, fa2, fa3) { (a, b, c) =>
      a + b + c
    }
    
    // Yields Failure(e), because the second arg is a failure
    Coeval.map3(fa1, Coeval.raiseError[Int](new RuntimeException("boo")), fa3) { (a, b, c) =>
      a + b + c
    }
  28. def map4[A1, A2, A3, A4, R](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4])(f: (A1, A2, A3, A4) ⇒ R): Coeval[R]

    Pairs 4 Coeval values, applying the given mapping function.

    Pairs 4 Coeval values, applying the given mapping function.

    Returns a new Coeval reference that completes with the result of mapping that function to their successful results, or in failure in case either of them fails.

    val fa1 = Coeval(1)
    val fa2 = Coeval(2)
    val fa3 = Coeval(3)
    val fa4 = Coeval(4)
    
    // Yields Success(10)
    Coeval.map4(fa1, fa2, fa3, fa4) { (a, b, c, d) =>
      a + b + c + d
    }
    
    // Yields Failure(e), because the second arg is a failure
    Coeval.map4(fa1, Coeval.raiseError[Int](new RuntimeException("boo")), fa3, fa4) {
      (a, b, c, d) => a + b + c + d
    }
  29. def map5[A1, A2, A3, A4, A5, R](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4], fa5: Coeval[A5])(f: (A1, A2, A3, A4, A5) ⇒ R): Coeval[R]

    Pairs 5 Coeval values, applying the given mapping function.

    Pairs 5 Coeval values, applying the given mapping function.

    Returns a new Coeval reference that completes with the result of mapping that function to their successful results, or in failure in case either of them fails.

    val fa1 = Coeval(1)
    val fa2 = Coeval(2)
    val fa3 = Coeval(3)
    val fa4 = Coeval(4)
    val fa5 = Coeval(5)
    
    // Yields Success(15)
    Coeval.map5(fa1, fa2, fa3, fa4, fa5) { (a, b, c, d, e) =>
      a + b + c + d + e
    }
    
    // Yields Failure(e), because the second arg is a failure
    Coeval.map5(fa1, Coeval.raiseError[Int](new RuntimeException("boo")), fa3, fa4, fa5) {
      (a, b, c, d, e) => a + b + c + d + e
    }
  30. def map6[A1, A2, A3, A4, A5, A6, R](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4], fa5: Coeval[A5], fa6: Coeval[A6])(f: (A1, A2, A3, A4, A5, A6) ⇒ R): Coeval[R]

    Pairs 6 Coeval values, applying the given mapping function.

    Pairs 6 Coeval values, applying the given mapping function.

    Returns a new Coeval reference that completes with the result of mapping that function to their successful results, or in failure in case either of them fails.

    val fa1 = Coeval(1)
    val fa2 = Coeval(2)
    val fa3 = Coeval(3)
    val fa4 = Coeval(4)
    val fa5 = Coeval(5)
    val fa6 = Coeval(6)
    
    // Yields Success(21)
    Coeval.map6(fa1, fa2, fa3, fa4, fa5, fa6) { (a, b, c, d, e, f) =>
      a + b + c + d + e + f
    }
    
    // Yields Failure(e), because the second arg is a failure
    Coeval.map6(fa1, Coeval.raiseError[Int](new RuntimeException("boo")), fa3, fa4, fa5, fa6) {
      (a, b, c, d, e, f) => a + b + c + d + e + f
    }
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def now[A](a: A): Coeval[A]

    Returns a Coeval that on execution is always successful, emitting the given strict value.

  35. def pure[A](a: A): Coeval[A]

    Lifts a value into the coeval context.

    Lifts a value into the coeval context. Alias for now.

  36. def raiseError[A](ex: Throwable): Coeval[A]

    Returns a Coeval that on execution is always finishing in error emitting the specified exception.

  37. def sequence[A, M[X] <: TraversableOnce[X]](sources: M[Coeval[A]])(implicit cbf: CanBuildFrom[M[Coeval[A]], A, M[A]]): Coeval[M[A]]

    Transforms a TraversableOnce of coevals into a coeval producing the same collection of gathered results.

    Transforms a TraversableOnce of coevals into a coeval producing the same collection of gathered results.

    It's a simple version of traverse.

  38. def suspend[A](fa: ⇒ Coeval[A]): Coeval[A]

    Alias for defer.

  39. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  40. def tailRecM[A, B](a: A)(f: (A) ⇒ Coeval[Either[A, B]]): Coeval[B]

    Keeps calling f until it returns a Right result.

    Keeps calling f until it returns a Right result.

    Based on Phil Freeman's Stack Safety for Free.

  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def traverse[A, B, M[X] <: TraversableOnce[X]](sources: M[A])(f: (A) ⇒ Coeval[B])(implicit cbf: CanBuildFrom[M[A], B, M[B]]): Coeval[M[B]]

    Transforms a TraversableOnce[A] into a coeval of the same collection using the provided function A => Coeval[B].

    Transforms a TraversableOnce[A] into a coeval of the same collection using the provided function A => Coeval[B].

    It's a generalized version of sequence.

  43. val unit: Coeval[Unit]

    A Coeval[Unit] provided for convenience.

  44. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  47. def zip2[A1, A2, R](fa1: Coeval[A1], fa2: Coeval[A2]): Coeval[(A1, A2)]

    Pairs two Coeval instances.

  48. def zip3[A1, A2, A3](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3]): Coeval[(A1, A2, A3)]

    Pairs three Coeval instances.

  49. def zip4[A1, A2, A3, A4](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4]): Coeval[(A1, A2, A3, A4)]

    Pairs four Coeval instances.

  50. def zip5[A1, A2, A3, A4, A5](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4], fa5: Coeval[A5]): Coeval[(A1, A2, A3, A4, A5)]

    Pairs five Coeval instances.

  51. def zip6[A1, A2, A3, A4, A5, A6](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3], fa4: Coeval[A4], fa5: Coeval[A5], fa6: Coeval[A6]): Coeval[(A1, A2, A3, A4, A5, A6)]

    Pairs six Coeval instances.

  52. def zipList[A](sources: Coeval[A]*): Coeval[List[A]]

    Zips together multiple Coeval instances.

  53. object Eager extends Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from CoevalInstancesLevel0

Inherited from AnyRef

Inherited from Any

Ungrouped