| | | 1 | | //======================================================================= |
| | | 2 | | // SwiftCollectionPool.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024–present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using SwiftCollections.Lazy; |
| | | 9 | | using System; |
| | | 10 | | using System.Collections.Generic; |
| | | 11 | | |
| | | 12 | | namespace SwiftCollections.Pool; |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// A generic pool for managing collections such as <see cref="List{T}"/>, <see cref="HashSet{T}"/>, |
| | | 16 | | /// <see cref="Dictionary{TKey, TValue}"/>, and other types implementing <see cref="ICollection{T}"/>. |
| | | 17 | | /// Provides efficient reuse of collection instances to reduce memory allocations. |
| | | 18 | | /// </summary> |
| | | 19 | | /// <typeparam name="TCollection">The type of the collection being pooled. Must implement <see cref="ICollection{TItem}" |
| | | 20 | | /// <typeparam name="TItem">The type of items contained in the collection.</typeparam> |
| | | 21 | | public abstract class SwiftCollectionPool<TCollection, TItem> where TCollection : class, ICollection<TItem>, new() |
| | | 22 | | { |
| | | 23 | | #region Singleton Instances |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Internal object pool for managing the lifecycle of pooled collections. |
| | | 27 | | /// Uses <see cref="Lazy{T}"/> to ensure lazy initialization. |
| | | 28 | | /// </summary> |
| | 36 | 29 | | private SwiftLazyDisposable<SwiftObjectPool<TCollection>> _lazyCollectionPool = |
| | 36 | 30 | | new(() => |
| | 36 | 31 | | { |
| | 36 | 32 | | return new SwiftObjectPool<TCollection>( |
| | 36 | 33 | | createFunc: () => new TCollection(), |
| | 36 | 34 | | actionOnRelease: collection => collection.Clear() |
| | 36 | 35 | | ); |
| | 36 | 36 | | }); |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Gets the shared instance of the pool. |
| | | 40 | | /// </summary> |
| | 56 | 41 | | public SwiftObjectPool<TCollection> CollectionPool => _lazyCollectionPool.Value; |
| | | 42 | | |
| | | 43 | | #endregion |
| | | 44 | | |
| | | 45 | | #region Methods |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Rents a collection from the pool. If the pool is empty, a new collection is created. |
| | | 49 | | /// </summary> |
| | | 50 | | /// <returns>A collection instance of type <typeparamref name="TCollection"/>.</returns> |
| | | 51 | | public virtual TCollection Rent() |
| | | 52 | | { |
| | 36 | 53 | | return CollectionPool.Rent(); |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Rents a collection from the pool and wraps it in a <see cref="SwiftPooledObject{TCollection}"/> for automatic re |
| | | 58 | | /// </summary> |
| | | 59 | | /// <param name="value">The rented collection.</param> |
| | | 60 | | /// <returns>A <see cref="SwiftPooledObject{TCollection}"/> instance wrapping the rented collection.</returns> |
| | | 61 | | public virtual SwiftPooledObject<TCollection> Get(out TCollection value) |
| | | 62 | | { |
| | 1 | 63 | | return CollectionPool.Rent(out value); |
| | | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Releases a collection back to the pool for reuse. |
| | | 68 | | /// </summary> |
| | | 69 | | /// <param name="toRelease">The collection to release.</param> |
| | | 70 | | public virtual void Release(TCollection toRelease) |
| | | 71 | | { |
| | 19 | 72 | | CollectionPool.Release(toRelease); |
| | 19 | 73 | | } |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Clears all collections from the pool. |
| | | 77 | | /// </summary> |
| | | 78 | | public virtual void Clear() |
| | | 79 | | { |
| | 35 | 80 | | if (_lazyCollectionPool.IsValueCreated) |
| | 27 | 81 | | _lazyCollectionPool.Value.Clear(); |
| | 35 | 82 | | } |
| | | 83 | | |
| | | 84 | | #endregion |
| | | 85 | | |
| | | 86 | | #region IDisposable Implementation |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Releases all resources used by the SwiftCollectionPool. |
| | | 90 | | /// </summary> |
| | | 91 | | public virtual void Flush() |
| | | 92 | | { |
| | 32 | 93 | | if (_lazyCollectionPool.IsValueCreated) |
| | | 94 | | { |
| | 24 | 95 | | _lazyCollectionPool.Value.Dispose(); |
| | | 96 | | |
| | 24 | 97 | | _lazyCollectionPool = new SwiftLazyDisposable<SwiftObjectPool<TCollection>>(() => |
| | 24 | 98 | | { |
| | 24 | 99 | | return new SwiftObjectPool<TCollection>( |
| | 24 | 100 | | createFunc: () => new TCollection(), |
| | 24 | 101 | | actionOnRelease: collection => collection.Clear() |
| | 24 | 102 | | ); |
| | 24 | 103 | | }); |
| | | 104 | | } |
| | | 105 | | |
| | 32 | 106 | | } |
| | | 107 | | |
| | | 108 | | #endregion |
| | | 109 | | } |