fetch

Type Members

1. final case class Cached[A](a: A) extends FetchOp[A] with Product with Serializable

   

2. final case class Concurrent(as: List[FetchMany[_, _]]) extends FetchOp[Env] with Product with Serializable

   

3. final case class ConcurrentRound(ids: Map[String, List[Any]]) extends RoundKind with Product with Serializable

   

4. trait DataSource[I, A] extends AnyRef

   

   A DataSource is the recipe for fetching a certain identity I, which yields results of type A.

5. trait DataSourceCache extends AnyRef

   

   A Cache trait so the users of the library can provide their own cache.

6. type DataSourceIdentity = (DataSourceName, Any)

   

7. type DataSourceName = String

   

8. trait Env extends AnyRef

   

   An environment that is passed along during the fetch rounds.

   An environment that is passed along during the fetch rounds. It holds the cache and the list of rounds that have been executed.

9. type Fetch[A] = Free[FetchOp, A]

   

10. case class FetchEnv(cache: DataSourceCache, ids: List[Any] = Nil, rounds: Queue[Round] = Queue.empty) extends Env with Product with Serializable

    

    A concrete implementation of Env used in the default Fetch interpreter.

11. final case class FetchError[A, E <: Throwable](err: E) extends FetchOp[A] with Product with Serializable

    

12. case class FetchFailure(env: Env) extends Throwable with Product with Serializable

    

    An exception thrown from the interpreter when failing to perform a data fetch.

13. type FetchInterpreter[M[_]] = AnyRef { type f[x] = cats.data.StateT[M,fetch.FetchEnv,x] }

    

14. trait FetchInterpreters extends AnyRef

    

15. final case class FetchMany[I, A](as: NonEmptyList[I], ds: DataSource[I, A]) extends FetchOp[List[A]] with Product with Serializable

    

16. type FetchMonadError[M[_]] = MonadError[M, Throwable]

    

17. final case class FetchOne[I, A](a: I, ds: DataSource[I, A]) extends FetchOp[A] with Product with Serializable

    

18. sealed abstract class FetchOp[A] extends Product with Serializable

    

    Primitive operations in the Fetch Free monad.

19. case class InMemoryCache(state: Map[DataSourceIdentity, Any]) extends DataSourceCache with Product with Serializable

    

    A cache that stores its elements in memory.

20. final case class ManyRound(ids: List[Any]) extends RoundKind with Product with Serializable

    

21. final case class OneRound(id: Any) extends RoundKind with Product with Serializable

    

22. case class Round(cache: DataSourceCache, ds: DataSourceName, kind: RoundKind, startRound: Long, endRound: Long, cached: Boolean = false) extends Product with Serializable

    

    A data structure that holds information about a fetch round.

23. sealed trait RoundKind extends AnyRef