Mill
API
Generated with
Mill/mill/mill.util/RefCountedCache

RefCountedCache

mill.util.RefCountedCache
See theRefCountedCache companion object
class RefCountedCache[Key, InternalKey, InitData, Value](convertKey: Key => InternalKey, setupFn: (Key, InternalKey, InitData) => Value, closeValue: Value => Unit) extends CachedFactoryBase[Key, InternalKey, InitData, Value]

Generic reference counted cache, where values are created on-demand and closed when no more references exist.

Provides a public API that uses Key, but transforms it to InternalKey for caching, usually for performance reasons.

Type parameters

InitData

transient initialization data that will be passed to setup

Attributes

Companion
object
Source
RefCountedCache.scala
Graph
Supertypes
class CachedFactoryBase[Key, InternalKey, InitData, Value]
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Type members

Inherited types

type Entry = Entry[Key, InternalKey, Value]

Attributes

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala

Value members

Concrete methods

def get(key: Key, initData: => InitData): Value

Binary compatibility forwarder

Binary compatibility forwarder

Attributes

Source
RefCountedCache.scala
def keyToInternalKey(key: Key): InternalKey

Convert the public key to an internal key used for caching.

Convert the public key to an internal key used for caching.

Attributes

Source
RefCountedCache.scala
def maxCacheSize: Int

Maximum number of unused values to keep in the LRU cache. Set to 0 to disable caching of unused values (values are closed immediately when released).

Maximum number of unused values to keep in the LRU cache. Set to 0 to disable caching of unused values (values are closed immediately when released).

Attributes

Source
RefCountedCache.scala
def setup(key: Key, internalKey: InternalKey, initData: InitData): Value

Create a new value for the given key.

Create a new value for the given key.

Attributes

Source
RefCountedCache.scala
def shareValues: Boolean

If true, a value can be used concurrently by multiple consumers (reference counted). If false, a value can only be used by one consumer at a time.

If true, a value can be used concurrently by multiple consumers (reference counted). If false, a value can only be used by one consumer at a time.

Attributes

Source
RefCountedCache.scala
def teardown(key: Key, internalKey: InternalKey, value: Value): Unit

Clean up a value when it is evicted from the cache.

Clean up a value when it is evicted from the cache.

Attributes

Source
RefCountedCache.scala

Inherited methods

def cacheEntryStillValid(key: Key, internalKey: InternalKey, initData: => InitData, value: Value): Boolean

Returns true if the cache entry associated with the given key is still valid. If false, the entry will be removed from the cache and setup will be invoked.

Returns true if the cache entry associated with the given key is still valid. If false, the entry will be removed from the cache and setup will be invoked.

Attributes

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
override def close(): Unit

Attributes

Definition Classes
CachedFactoryBase -> AutoCloseable
Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
def getOrCreate(key: Key, initData: => InitData): Value

Get a value for the given key, creating one if necessary. The caller must call release when done with the value.

Get a value for the given key, creating one if necessary. The caller must call release when done with the value.

Attributes

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
def release(key: Key): Option[Entry]

Release a reference to the value associated with the given key. If this was the last reference, the value moves to the unused cache.

Release a reference to the value associated with the given key. If this was the last reference, the value moves to the unused cache.

Attributes

Returns

Some(entry) if there are still active references (only possible in shared mode), None otherwise

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
def releaseKeyValue(key: Key, value: Value): Option[Entry]

Release a reference to a specific value, matching by value identity. This should be used when shareValues = false and multiple entries may have the same key.

Release a reference to a specific value, matching by value identity. This should be used when shareValues = false and multiple entries may have the same key.

Attributes

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
def withValue[R](key: Key, initData: => InitData)(block: Value => R): R

Get a value, use it in the provided block, then release it.

Get a value, use it in the provided block, then release it.

Attributes

Inherited from:
CachedFactoryBase
Source
CachedFactoryBase.scala
Generated with