Added: Generic ArrayRental

Author: Sewer56

docs/Utilities/ArrayRental.md

@@ -1,6 +1,8 @@
 # ArrayRental
 
 !!! info "`ArrayRental` is a struct that represents an instance of a rented array. It should be disposed of after use with the `using` statement."
+
+!!! tip "If you need a generic version, use `ArrayRental<T>`."
 
 The underlying array is managed by the shared `ArrayPool`.  
 

src/Reloaded.Memory/Utilities/ArrayRental.cs

@@ -27,3 +27,29 @@ namespace Reloaded.Memory.Utilities;
     /// <inheritdoc />
     public void Dispose() => ArrayPool<byte>.Shared.Return(Array);
 }
+
+/// <summary>
+///     Instance of a rented array of type T. Don't forget to dispose me please!
+/// </summary>
+/// <typeparam name="T">Type of item stored in this rental.</typeparam>
+public readonly struct ArrayRental<T> : IDisposable
+{
+    /// <summary>
+    ///     The underlying array for this rental.
+    /// </summary>
+    public T[] Array { get; }
+
+    /// <summary>
+    ///     Returns the span for given rented array.
+    /// </summary>
+    public Span<T> Span => Array.AsSpanFast();
+
+    /// <summary>
+    ///     Rents a provided number of bytes.
+    /// </summary>
+    /// <param name="numBytes">Minimum number of items to rent.</param>
+    public ArrayRental(int numBytes) => Array = ArrayPool<T>.Shared.Rent(numBytes);
+
+    /// <inheritdoc />
+    public void Dispose() => ArrayPool<T>.Shared.Return(Array);
+}

src/Reloaded.Memory/Utilities/ArrayRentalSlice.cs

@@ -39,3 +39,42 @@ public ArrayRentalSlice(ArrayRental rental, int length)
     /// <inheritdoc />
     public void Dispose() => Rental.Dispose();
 }
+
+/// <summary>
+///     Represents a slice of an <see cref="ArrayRental{T}" />.
+///     This API is meant to be used as a return value from methods, and transfers control of the rental from the internal
+///     <see cref="ArrayRental{T}" />.
+/// </summary>
+/// <typeparam name="T">Type of item stored in this slice.</typeparam>
+[PublicAPI]
+public struct ArrayRentalSlice<T> : IDisposable
+{
+    /// <summary>
+    ///     The underlying rental.
+    /// </summary>
+    public ArrayRental<T> Rental { get; }
+
+    /// <summary>
+    ///     Returns the span for the rented slice.
+    /// </summary>
+    public Span<T> Span => Rental.Array.AsSpanFast(0, Length);
+
+    /// <summary>
+    ///     Length of this slice.
+    /// </summary>
+    public int Length { get; }
+
+    /// <summary>
+    ///     Represents a slice of the array rental.
+    /// </summary>
+    /// <param name="rental">The underlying rental.</param>
+    /// <param name="length">Number of items in the underlying rental.</param>
+    public ArrayRentalSlice(ArrayRental<T> rental, int length)
+    {
+        Rental = rental;
+        Length = length;
+    }
+
+    /// <inheritdoc />
+    public void Dispose() => Rental.Dispose();
+}