ZeroAlloc.Cache.Generator 1.0.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package ZeroAlloc.Cache.Generator --version 1.0.1

NuGet\Install-Package ZeroAlloc.Cache.Generator -Version 1.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="1.0.1">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ZeroAlloc.Cache.Generator" Version="1.0.1" />
                    

                            Directory.Packages.props

<PackageReference Include="ZeroAlloc.Cache.Generator">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    

                            Project file

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 1.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ZeroAlloc.Cache.Generator, 1.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@1.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=1.0.1
                    

                            Install as a Cake Addin

#tool nuget:?package=ZeroAlloc.Cache.Generator&version=1.0.1
                    

                            Install as a Cake Tool

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

Telemetry

Each cached method emits both metrics (via Meter("ZeroAlloc.Cache")) and a tracing span (via ActivitySource("ZeroAlloc.Cache")) — no extra package required, plain BCL System.Diagnostics.

Breaking change in 2.0: Meter name renamed from "zeroalloc.cache" to "ZeroAlloc.Cache" for ecosystem consistency with the other ZeroAlloc telemetry packages. Subscribers must update — calls to AddMeter("zeroalloc.cache") will silently stop receiving metrics:
-services.AddOpenTelemetry().WithMetrics(m => m.AddMeter("zeroalloc.cache"));
+services.AddOpenTelemetry().WithMetrics(m => m.AddMeter("ZeroAlloc.Cache"));

Metrics. Counters tagged with method (the cached method name): cache.hits, cache.misses, cache.evictions, cache.hybrid_calls (factory invocations on the HybridCache path). The cache.lookup_duration_ms histogram records per-lookup latency tagged with cache.method.

Tracing. Each cached method emits a cache.lookup span tagged with:

Tag	Value	Notes
`cache.method`	`"Interface.Method"`	Compile-time constant per emitted method
`cache.tier`	`"L1"` or `"L2"`	`L1` = in-process `MemoryCache`; `L2` = `HybridCache`
`cache.hit`	`true` / `false`	L1 only — `HybridCache` hides per-call hit/miss state, so this tag is omitted on the L2 path

Subscribe via OpenTelemetry:

services.AddOpenTelemetry()
    .WithMetrics(m => m.AddMeter("ZeroAlloc.Cache"))
    .WithTracing(t => t.AddSource("ZeroAlloc.Cache"));

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/:

License

MIT

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has 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.

Version	Downloads	Last Updated
1.1.2	45	5/20/2026
1.1.1	84	5/18/2026
1.1.0	84	5/13/2026
1.0.5	84	5/12/2026
1.0.4	82	5/12/2026
1.0.3	96	5/9/2026
1.0.2	84	5/7/2026
1.0.1	84	5/6/2026
1.0.0	81	5/4/2026
0.0.1	97	4/21/2026