ZeroAlloc.Cache.Generator
0.0.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package ZeroAlloc.Cache.Generator --version 0.0.1
NuGet\Install-Package ZeroAlloc.Cache.Generator -Version 0.0.1
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="ZeroAlloc.Cache.Generator" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ZeroAlloc.Cache.Generator" Version="0.0.1" />
<PackageReference Include="ZeroAlloc.Cache.Generator" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add ZeroAlloc.Cache.Generator --version 0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ZeroAlloc.Cache.Generator, 0.0.1"
#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.
#:package ZeroAlloc.Cache.Generator@0.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=ZeroAlloc.Cache.Generator&version=0.0.1
#tool nuget:?package=ZeroAlloc.Cache.Generator&version=0.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ZeroAlloc.Cache
Source-generated zero-allocation caching proxy from an annotated interface.
Add [Cache] to an interface and a Roslyn source generator emits a proxy class that transparently intercepts every method call, returning a cached result on hit with no heap allocation on the cache-hit path. Backed by IMemoryCache by default, with optional HybridCache (L1 + L2) opt-in per method. AOT-safe.
Quick start
dotnet add package ZeroAlloc.Cache
[Cache(TtlMs = 60_000)]
public interface IProductRepository
{
ValueTask<Product?> GetByIdAsync(int id, CancellationToken ct);
[Cache(TtlMs = 300_000, MaxEntries = 1_000)]
ValueTask<IReadOnlyList<Product>> SearchAsync(string query, CancellationToken ct);
}
// Register — one line wires everything
builder.Services.AddIProductRepositoryCache<ProductRepositoryImpl>();
Inject IProductRepository anywhere — caching is transparent to the caller.
public class ProductsController(IProductRepository repo)
{
public async Task<Product?> Get(int id, CancellationToken ct)
=> await repo.GetByIdAsync(id, ct); // cache hit = zero allocation
}
Features
| Feature | Notes |
|---|---|
| Zero allocation on cache hit | Key is built at compile time; no boxing, no string interpolation at runtime |
IMemoryCache (default) |
In-process L1 cache; no extra dependencies |
HybridCache (opt-in) |
L1 + L2 distributed cache via Microsoft.Extensions.Caching.Hybrid |
| Method-level override | Any [Cache] on a method shadows the interface-level config for that method |
MaxEntries |
Isolates the method in its own MemoryCache instance with a SizeLimit |
| Compile-time key | Cache key expression is emitted by the generator — zero key-building overhead on hit |
| AOT / trimmer safe | Generated proxy is concrete; no reflection at runtime |
| DI integration | Generated Add{IService}Cache<TImpl>() extension registers everything |
Cache behavior
| Scenario | Behavior |
|---|---|
| Miss | Inner implementation is called; result is stored in cache with the configured TTL; result is returned |
| Hit | Cached value is returned directly; inner implementation is never invoked; no heap allocation |
Diagnostics
| ID | Severity | Description |
|---|---|---|
| ZC0001 | Warning | Sliding = true combined with UseHybridCache = true — sliding TTL is silently ignored by the distributed (L2) tier |
| ZC0002 | Warning | A cache key parameter is a reference type (excluding string) — ToString() may not produce a stable unique key |
Documentation
Full docs live in docs/:
- Getting Started
- Attribute Reference
- Diagnostics: ZC0001 · ZC0002
License
MIT
| Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 was computed. |
| .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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.