.NET-Community-Toolkit/CommunityToolkit.HighPerformance/Buffers/Internals/Interfaces/IMemoryManager.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using System;
using System.Buffers;

namespace CommunityToolkit.HighPerformance.Buffers.Internals.Interfaces;

/// <summary>
/// An interface for a <see cref="MemoryManager{T}"/> instance that can reinterpret its underlying data.
/// </summary>
internal interface IMemoryManager
{
    /// <summary>
    /// Creates a new <see cref="Memory{T}"/> that reinterprets the underlying data for the current instance.
    /// </summary>
    /// <typeparam name="T">The target type to cast the items to.</typeparam>
    /// <param name="offset">The starting offset within the data store.</param>
    /// <param name="length">The original used length for the data store.</param>
    /// <returns>A new <see cref="Memory{T}"/> instance of the specified type, reinterpreting the current items.</returns>
    Memory<T> GetMemory<T>(int offset, int length)
        where T : unmanaged;
}