Initial Commit

Author: Taiizor

src/CacheFlow/Abstractions/IBufferDistributedCacheEntry.cs

@@ -0,0 +1,34 @@
+using Microsoft.Extensions.Caching.Distributed;
+
+namespace CacheFlow.Abstractions;
+
+/// <summary>
+/// Represents a buffer-based distributed cache entry that supports efficient memory usage.
+/// </summary>
+public interface IBufferDistributedCacheEntry : IAsyncDisposable, IDisposable
+{
+    /// <summary>
+    /// Gets the buffer for writing cache data.
+    /// </summary>
+    Memory<byte> Buffer { get; }
+
+    /// <summary>
+    /// Sets the length of valid data in the buffer.
+    /// </summary>
+    /// <param name="length">The length of valid data.</param>
+    void SetLength(int length);
+
+    /// <summary>
+    /// Completes the cache entry with the specified options.
+    /// </summary>
+    /// <param name="options">The cache entry options.</param>
+    void Complete(DistributedCacheEntryOptions options);
+
+    /// <summary>
+    /// Asynchronously completes the cache entry with the specified options.
+    /// </summary>
+    /// <param name="options">The cache entry options.</param>
+    /// <param name="token">Optional cancellation token.</param>
+    /// <returns>A task representing the asynchronous operation.</returns>
+    Task CompleteAsync(DistributedCacheEntryOptions options, CancellationToken token = default);
+}