Object/Class

monix.eval

Coeval

Related Docs: class Coeval | package eval

Permalink

object Coeval extends Serializable

Coeval builders.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Coeval
  2. Serializable
  3. Serializable
  4. AnyRef
  5. 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

    Permalink

    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

    Permalink

    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(ex: Throwable) extends Eager[Nothing] with Product with Serializable

    Permalink

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

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

    Permalink

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

  5. final class Once[+A] extends Coeval[A] with () ⇒ A

    Permalink

    Constructs a lazy Coeval instance that gets evaluated only once.

    Constructs a lazy Coeval instance that gets evaluated only once.

    In some sense it is equivalent to using a lazy val. When caching is not required or desired, prefer Always or Now.

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. object Eager extends Serializable

    Permalink
  5. object Once extends Serializable

    Permalink
  6. def apply[A](f: ⇒ A): Coeval[A]

    Permalink

    Promotes a non-strict value to a Coeval.

    Promotes a non-strict value to a Coeval.

    Alias of eval.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. implicit def catsInstances: CatsSyncInstances[Coeval]

    Permalink

    Type class instances of Coeval for Cats.

  9. def clone(): AnyRef

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

    Permalink

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

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

    Permalink

    Alias for eval.

  12. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. def eval[A](a: ⇒ A): Coeval[A]

    Permalink

    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]

    Permalink

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

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def fromEval[A](a: Eval[A]): Coeval[A]

    Permalink

    Builds a Coeval out of a cats.Eval value.

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

    Permalink

    Builds a Coeval out of a Scala Try value.

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

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

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

    Permalink
    Definition Classes
    Any
  22. def map2[A1, A2, R](fa1: Coeval[A1], fa2: Coeval[A2])(f: (A1, A2) ⇒ R): Coeval[R]

    Permalink

    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(e)) { (a, b) =>
      a + b
    }
  23. def map3[A1, A2, A3, R](fa1: Coeval[A1], fa2: Coeval[A2], fa3: Coeval[A3])(f: (A1, A2, A3) ⇒ R): Coeval[R]

    Permalink

    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(e), fa3) { (a, b, c) =>
      a + b + c
    }
  24. 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]

    Permalink

    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(e), fa3, fa4) {
      (a, b, c, d) => a + b + c + d
    }
  25. 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]

    Permalink

    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(e), fa3, fa4, fa5) {
      (a, b, c, d, e) => a + b + c + d + e
    }
  26. 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]

    Permalink

    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(e), fa3, fa4, fa5, fa6) {
      (a, b, c, d, e, f) => a + b + c + d + e + f
    }
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  30. def now[A](a: A): Coeval[A]

    Permalink

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

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

    Permalink

    Lifts a value into the coeval context.

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

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

    Permalink

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

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

    Permalink

    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.

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

    Permalink

    Alias for defer.

  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def tailRecM[A, B](a: A)(f: (A) ⇒ Coeval[Either[A, B]]): Coeval[B]

    Permalink

    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.

  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. 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]]

    Permalink

    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.

  39. val unit: Coeval[Unit]

    Permalink

    A Coeval[Unit] provided for convenience.

  40. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. def zip2[A1, A2, R](fa1: Coeval[A1], fa2: Coeval[A2]): Coeval[(A1, A2)]

    Permalink

    Pairs two Coeval instances.

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

    Permalink

    Pairs three Coeval instances.

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

    Permalink

    Pairs four Coeval instances.

  46. 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)]

    Permalink

    Pairs five Coeval instances.

  47. 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)]

    Permalink

    Pairs six Coeval instances.

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

    Permalink

    Zips together multiple Coeval instances.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped