Enable 'await' on CacheEntity/CacheEntityReference to make the usage less verbose/tedious +semver: minor

Author: calledude

AsyncMemoryCache.Tests/AsyncMemoryCacheTests.cs

@@ -46,7 +46,7 @@ public async Task GetOrCreateObjectIsReturnedInCacheEntity()
 
 		var cacheEntityReference = target.GetOrCreate("test", factory);
 
-		var cachedObject = await cacheEntityReference.CacheEntity.ObjectFactory;
+		var cachedObject = await cacheEntityReference.CacheEntity;
 		Assert.Same(objectToCache, cachedObject);
 	}
 
@@ -62,7 +62,7 @@ public async Task GetOrCreateObjectIsReturnedFromIndexer()
 		const string cacheKey = "test";
 		_ = target.GetOrCreate(cacheKey, factory);
 
-		var cachedObject = await target[cacheKey].CacheEntity.ObjectFactory;
+		var cachedObject = await target[cacheKey];
 		Assert.Same(objectToCache, cachedObject);
 	}
 

AsyncMemoryCache/AsyncMemoryCache.cs

@@ -159,7 +159,7 @@ public async ValueTask DisposeAsync()
 		var diposeTasks = _configuration.CacheBackingStore
 			.Select(async x =>
 			{
-				var cachedObject = await x.Value.ObjectFactory;
+				var cachedObject = await x.Value;
 				await cachedObject.DisposeAsync().ConfigureAwait(false);
 			});
 

AsyncMemoryCache/CacheEntity.cs

@@ -1,6 +1,9 @@
 using AsyncMemoryCache.ExpirationStrategy;
 using Nito.AsyncEx;
 using System;
+using System.ComponentModel;
+using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
 
 namespace AsyncMemoryCache;
@@ -41,6 +44,26 @@ public CacheEntity(TKey key, Func<Task<TValue>> objectFactory, AsyncLazyFlags la
 	internal IExpirationStrategy? ExpirationStrategy { get; private set; }
 	internal Action<TKey, TValue>? ExpirationCallback { get; private set; }
 
+	/// <summary>
+	/// Asynchronous infrastructure support. This method permits instances of <see cref="CacheEntity{TKey, TValue}"/> to be await'ed.
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public TaskAwaiter<TValue> GetAwaiter()
+	{
+		return ObjectFactory.Task.GetAwaiter();
+	}
+
+	/// <summary>
+	/// Asynchronous infrastructure support. This method permits instances of <see cref="CacheEntity{TKey, TValue}"/> to be await'ed.
+	/// </summary>
+#if NET8_0_OR_GREATER
+	[ExcludeFromCodeCoverage(Justification = "There's no real functionality to be tested here, it's just enabling await")]
+#endif
+	public ConfiguredTaskAwaitable<TValue> ConfigureAwait(bool continueOnCapturedContext)
+	{
+		return ObjectFactory.Task.ConfigureAwait(continueOnCapturedContext);
+	}
+
 	/// <summary>
 	/// Sets the <see cref="ExpirationStrategy"/> to a new instance of <see cref="AbsoluteExpirationStrategy"/>.<br/>
 	/// This strategy takes an absolute date into account when evaluating whether or not it is expired.<br/>

AsyncMemoryCache/CacheEntityReference.cs

@@ -1,6 +1,9 @@
 using AsyncMemoryCache.EvictionBehaviors;
+using Microsoft.Extensions.DependencyInjection;
 using System;
+using System.ComponentModel;
 using System.Diagnostics.CodeAnalysis;
+using System.Runtime.CompilerServices;
 using System.Threading;
 
 namespace AsyncMemoryCache;
@@ -39,6 +42,26 @@ public CacheEntityReference(CacheEntity<TKey, TValue> cacheEntity)
 		_ = Interlocked.Increment(ref cacheEntity.References);
 	}
 
+	/// <summary>
+	/// Asynchronous infrastructure support. This method permits instances of <see cref="CacheEntityReference{TKey, TValue}"/> to be await'ed.
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public TaskAwaiter<TValue> GetAwaiter()
+	{
+		return CacheEntity.GetAwaiter();
+	}
+
+	/// <summary>
+	/// Asynchronous infrastructure support. This method permits instances of <see cref="CacheEntityReference{TKey, TValue}"/> to be await'ed.
+	/// </summary>
+#if NET8_0_OR_GREATER
+	[ExcludeFromCodeCoverage(Justification = "There's no real functionality to be tested here, it's just enabling await")]
+#endif
+	public ConfiguredTaskAwaitable<TValue> ConfigureAwait(bool continueOnCapturedContext)
+	{
+		return CacheEntity.ConfigureAwait(continueOnCapturedContext);
+	}
+
 	/// <summary>
 	/// The finalizer for <see cref="CacheEntityReference{TKey, TValue}"/>.
 	/// This serves as a fail-safe if <see cref="Dispose"/> is never called.

AsyncMemoryCache/EvictionBehaviors/DefaultEvictionBehavior.cs

@@ -103,7 +103,7 @@ private static async Task CheckExpiredItems<TKey, TValue>(IAsyncMemoryCacheConfi
 		foreach (var expiredItem in expiredItems)
 		{
 			logger.LogTrace("Expiring item with key {Key}", expiredItem.Key);
-			var item = await expiredItem.ObjectFactory;
+			var item = await expiredItem;
 			if (cache.Remove(expiredItem.Key))
 			{
 				configuration.CacheItemExpired?.Invoke(expiredItem.Key, item);

README.md

@@ -45,7 +45,7 @@ var cacheEntityReference = cache.GetOrCreate("theKey", async () =>
 cacheEntityReference.CacheEntity.WithSlidingExpiration(TimeSpan.FromHours(12));
 
 // Will block here until the object is created
-var theCachedObject = await cache["theKey"].CacheEntity.ObjectFactory;
+var theCachedObject = await cache["theKey"]; // Short-hand for await cache["theKey"].CacheEntity.ObjectFactory;
 ```
 
 ### Extending the lifetime of a cached object