Packages

p

zio

cache

package cache

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed abstract class Cache[-Key, +Error, +Value] extends AnyRef

    A Cache is defined in terms of a lookup function that, given a key of type Key, can either fail with an error of type Error or succeed with a value of type Value.

    A Cache is defined in terms of a lookup function that, given a key of type Key, can either fail with an error of type Error or succeed with a value of type Value. Getting a value from the cache will either return the previous result of the lookup function if it is available or else compute a new result with the lookup function, put it in the cache, and return it.

    A cache also has a specified capacity and time to live. When the cache is at capacity the least recently accessed values in the cache will be removed to make room for new values. Getting a value with a life older than the specified time to live will result in a new value being computed with the lookup function and returned when available.

    The cache is safe for concurrent access. If multiple fibers attempt to get the same key the lookup function will only be computed once and the result will be returned to all fibers.

  2. final case class CacheStats(hits: Long, misses: Long, size: Int) extends Product with Serializable

    CacheStats represents a snapshot of statistics for the cache as of a point in time.

  3. final case class EntryStats(loaded: Instant) extends Product with Serializable

    EntryStats represents a snapshot of statistics for an entry in the cache.

  4. final case class Lookup[-Key, -Environment, +Error, +Value](lookup: (Key) => ZIO[Environment, Error, Value]) extends (Key) => ZIO[Environment, Error, Value] with Product with Serializable

    A Lookup represents a lookup function that, given a key of type Key, can return a ZIO effect that will either produce a value of type Value or fail with an error of type Error using an environment of type Environment.

    A Lookup represents a lookup function that, given a key of type Key, can return a ZIO effect that will either produce a value of type Value or fail with an error of type Error using an environment of type Environment.

    You can think of a Lookup as an effectual function that computes a value given a key. Given any effectual function you can convert it to a lookup function for a cache by using the Lookup constructor.

  5. sealed abstract class ManagedCache[-Key, +Error, +Value] extends AnyRef
  6. final case class ManagedLookup[-Key, -Environment, +Error, +Value](lookup: (Key) => ZManaged[Environment, Error, Value]) extends (Key) => ZManaged[Environment, Error, Value] with Product with Serializable

    Like lookup but managed version

Value Members

  1. case object BuildInfo extends Product with Serializable

    This object was generated by sbt-buildinfo.

  2. object Cache
  3. object ManagedCache

Ungrouped