Packages

trait Effect[F[_]] extends AnyRef

an effect type class. a monad describing how the persistence operations in longevity are processed. effects are typically found implicitly when building your LongevityContext. common effects are found within the Effect companion object.

the methods within this trait are used internally by longevity, and are only important to users who wish to implement their own effect type classes.

F

the effectful type

Source
Effect.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Effect
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def flatMap[A, B](fa: F[A])(f: (A) ⇒ F[B]): F[B]

    flatMap an F[A] to an F[B] according to function f with type A => F[B]

  2. abstract def map[A, B](fa: F[A])(f: (A) ⇒ B): F[B]

    map an F[A] to an F[B] according to function f with type A => B

  3. abstract def mapBlocking[A, B](fa: F[A])(f: (A) ⇒ B): F[B]

    map an F[A] to an F[B], using whatever means the effect has to perform potentially blocking operations.

    map an F[A] to an F[B], using whatever means the effect has to perform potentially blocking operations. for example, the effect may choose to perform the operation in a worker thread

  4. abstract def pure[A](a: A): F[A]

    lift a raw value with type A into an F[A]

  5. abstract def run[A](fa: F[A]): A

    execute the effects and produce a result.

    execute the effects and produce a result. this is only used in the test frameworks, which need to execute effects to check the result

    See also

    longevity.test

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Effect[F] to any2stringadd[Effect[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Effect[F], B)
    Implicit
    This member is added by an implicit conversion from Effect[F] to ArrowAssoc[Effect[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def ensuring(cond: (Effect[F]) ⇒ Boolean, msg: ⇒ Any): Effect[F]
    Implicit
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Effect[F]) ⇒ Boolean): Effect[F]
    Implicit
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Effect[F]
    Implicit
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Effect[F]
    Implicit
    This member is added by an implicit conversion from Effect[F] to Ensuring[Effect[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Effect[F] to StringFormat[Effect[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  27. def →[B](y: B): (Effect[F], B)
    Implicit
    This member is added by an implicit conversion from Effect[F] to ArrowAssoc[Effect[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Effect[F] to any2stringadd[Effect[F]]

Inherited by implicit conversion StringFormat from Effect[F] to StringFormat[Effect[F]]

Inherited by implicit conversion Ensuring from Effect[F] to Ensuring[Effect[F]]

Inherited by implicit conversion ArrowAssoc from Effect[F] to ArrowAssoc[Effect[F]]

Ungrouped