ObjectPool

A simple object pool that reuses instances of a reference type to reduce allocations.

C# Signature

internal sealed class ObjectPool<T> : System.IDisposable where T : class

Examples

The following example creates an object pool for a custom reference type.

C#

using System;
using Hertzole.SourceGen;

public sealed class Buffer
{
    public byte[] Data = new byte[1024];
}

public static class BufferPooling
{
    public static void Use()
    {
        // The pool can be disposed to invoke onDispose for the remaining objects.
        using ObjectPool<Buffer> pool = new ObjectPool<Buffer>(create: () => new Buffer(), onReturn: buffer => buffer.Data.AsSpan().Clear());

        Buffer buffer = pool.Get();
        // Do work with the buffer...
        pool.Return(buffer);
    }
}

Constructors

ObjectPool(Func<T>, Action<T>?, Action<T>?, Action<T>?)

Creates a new object pool.

C# Signature

public ObjectPool(Func<T> create, Action<T>? onGet = null, Action<T>? onReturn = null, Action<T>? onDispose = null);

create

A factory function to create new instances when the pool is empty.

onGet

An optional callback invoked when an object is retrieved from the pool.

onReturn

An optional callback invoked when an object is returned to the pool.

onDispose

An optional callback invoked for each remaining object when the pool is disposed.

Methods

Dispose()

Disposes the pool, invoking the onDispose callback for each remaining object.

C# Signature

public void Dispose();

Get()

Retrieves an object from the pool. Creates a new instance if the pool is empty.

C# Signature

public T Get();

Returns

An object from the pool.

Get(out T)

Retrieves an object from the pool and wraps it in a disposable scope that returns it automatically.

C# Signature

public PoolScope<T> Get(out T item);

item

When this method returns, contains the object retrieved from the pool.

Returns

A disposable scope that returns the object to the pool when disposed.

Return(T)

Returns an object to the pool.

C# Signature

public void Return(T value);

value

The object to return to the pool.