Pool

sealed interface Pool<E : Any>

An object pool for reusing mutable objects to reduce garbage collection overhead.

Type of objects to be pooled

Types

abstract fun borrow(): E

Borrow an object from the pool. If pool is empty, a new object is created.

abstract fun borrowInto(destination: MutableCollection<E>, count: Int)

Borrow count objects and add them into destination. The order of addition is not permitted.

abstract fun clear(): Int

Clear all stored objects.

abstract fun clearInto(destination: MutableCollection<E>): Int

Clear all stored objects and add them into destination. The order of addition is not permitted.

abstract fun recycle(value: E)

Recycle an object back to the pool for future reuse.

abstract fun recycleAll(values: Iterable<E>)

Recycle multiple objects at once.

Returns a thread-safe synchronized version of this pool.

inline fun <E : Any, R> Pool<E>.use(action: (E) -> R): R

Scoped use of a pooled object. Automatically recycles the object after use.