ThoughtStuff.Caching.FileSystem 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ThoughtStuff.Caching.FileSystem --version 1.0.0
NuGet\Install-Package ThoughtStuff.Caching.FileSystem -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ThoughtStuff.Caching.FileSystem" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ThoughtStuff.Caching.FileSystem --version 1.0.0
#r "nuget: ThoughtStuff.Caching.FileSystem, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ThoughtStuff.Caching.FileSystem as a Cake Addin
#addin nuget:?package=ThoughtStuff.Caching.FileSystem&version=1.0.0

// Install ThoughtStuff.Caching.FileSystem as a Cake Tool
#tool nuget:?package=ThoughtStuff.Caching.FileSystem&version=1.0.0

ThoughtStuff.Caching

Injects look-through cache for configured services

Quick Start

// Cache results returned from MySlowService in Mem Cache
services.AddMethodCaching()
        .AddTransientWithCaching<IMySlowService, MySlowService, MyResult>();

var app = builder.Build();

// Configure method caching policies
var methodCachePolicies = app.Services.GetRequiredService<IMethodCacheOptionsLookup>();
methodCachePolicies.AddRelativeExpiration<IMySlowService>(TimeSpan.FromSeconds(30));

Details

Suppose you have a slow service that fetches information on books by ISBN.

public interface IBookInfoService
{
    BookInfo GetBookInfo(string isbn);
}

class BookInfoService : IBookInfoService
{
    public BookInfo GetBookInfo(string isbn) { ... }
}

The service is slow and book information changes infrequently, so you would like to cache it. Rather than registering BookInfoService with .AddTransient you can use .AddTransientWithCaching.

services.AddMethodCaching()
        .AddTransientWithCaching<IBookInfoService, BookInfoService, BookInfo>();

The above will register a caching proxy for IBookInfoService which will wrap BookInfoService. The first call to get info on a particular book will use BookInfoService, but subsequent calls to get info on the same book will return the cached result from the first call.

void Example([Inject] IBookInfoService bookInfoService)
{
    var info1 = bookInfoService.GetBookInfo("1234");    // Slow. Saves cache entry using key "GetBookInfo(1234)"
    var info2 = bookInfoService.GetBookInfo("1234");    // Fast. Returns cache entry found using key "GetBookInfo(1234)"
    Assert.Equals(info1, info2);
}

Current Limitations

Single Return Type per Interface

Only one return type can be cached per service interface. This works well for services that implement a Single Responsibility, but not for larger classes. Often times simplified interface(s) can be created. The simplified interfaces may only have 1 function each and all be implemented by the large class.

Transient Lifetime

Only the Transient lifetime is implemented.

Cache Key uses Interface Name + Method Name + Arguments

A cache key is automatically generated from the method invocation based on the method name and passed arguments. For example: "IMyBookService.GetBookInfo('The Great Gatsby')". Other environment information is not included.

Be careful in multi-user or multi-tenant environments not to cache user-specific or tenant-specific results. For example, caching a method like GetCurrentUserFavoriteColor() would end up returning the same color for all users. To make it amenable to method caching change it to GetUserFavoriteColor(userId).


The programmer, like the poet, works only slightly removed from pure thought-stuff. He builds his castles in the air, from air, creating by exertion of the imagination. Few media of creation are so flexible, so easy to polish and rework, so readily capable of realizing grand conceptual structures.

— Fred P. Brooks

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 177 4/5/2023
1.1.0 172 4/4/2023
1.0.1 175 4/3/2023
1.0.0 192 3/29/2023
0.11.0 203 3/15/2023