Source-generated, awaitable INotifyPropertyChanged for .NET: await vm.SetNameAsync("Alice") returns only after every async handler has finished, with no reflection and NativeAOT support.
- Setters you can
await. Async validation, saving or coordinated state changes complete before the setter returns. CommunityToolkit.Mvvm and PropertyChanged.Fody only offer synchronous notifications. - 0 B per change, with or without subscribers, for reference-type properties and value types of up to 16 bytes without references, such as
int,decimalorGuid. The property event args are structs, and their old and new values keep such a value type inline instead of boxing it; tests assert 0 B for sequential and parallel dispatch with synchronous handlers. A larger struct, or one that contains references, is boxed once per value. - Works under NativeAOT and trimming. All plumbing is generated at compile time; CI publishes and runs a NativeAOT sample on every build.
- Compile-time diagnostics. A class that is not
partial, a record, or a stray[ObservableProperty]is reported by the build, not discovered at runtime.
dotnet add package ZeroAlloc.NotifyThe source generator ships inside the package.
using ZeroAlloc.Notify;
var user = new UserViewModel();
user.PropertyChangedAsync += async (args, ct) =>
{
await Task.Delay(100, ct); // e.g. save to a server
Console.WriteLine($"{args.PropertyName}: {args.OldValue} -> {args.NewValue}, saved");
};
await user.SetNameAsync("Alice"); // returns after the handler has saved
await user.SetAgeAsync(30);
[NotifyPropertyChangedAsync]
public partial class UserViewModel
{
[ObservableProperty] private string _name = "";
[ObservableProperty] private int _age;
}The generator writes the Name and Age properties, the SetNameAsync and SetAgeAsync setters and the PropertyChangedAsync event.
- Async property notifications, before and after a change:
[NotifyPropertyChangedAsync]and[NotifyPropertyChangingAsync]. Observable properties - Async collection notifications with
[NotifyCollectionChangedAsync]. Collection changes - Async validation through
INotifyDataErrorInfoAsync. Validation - Parallel handlers by default, sequential on request with
[InvokeSequentially], and aCancellationTokenon every setter. Async notifications - Build-time checks, ZAN001 to ZAN006. Diagnostics
- Typed old and new values:
args.NewValue.As<int>()reads a value without boxing it. Observable properties - Targets
net10.0andnet11.0. - Built on ZeroAlloc.AsyncEvents, the async event primitive behind every handler.
One property change with five handlers attached, .NET 10, all four libraries in one BenchmarkDotNet run. Allocations are exact; the ratio is each library's time against a hand-written INotifyPropertyChanged in the same run. Absolute timings are not published.
| Library | Ratio | Allocated | Async handlers |
|---|---|---|---|
Manual INotifyPropertyChanged |
1.00 | 24 B | no |
| PropertyChanged.Fody | 0.76 | 0 B | no |
| CommunityToolkit.Mvvm | 1.35 | 0 B | no |
| ZeroAlloc.Notify | 1.52 | 0 B | yes |
Awaitable handlers have a cost: Notify is slower than hand-written code, Fody and CommunityToolkit.Mvvm. For purely synchronous view models, Fody is the faster choice. Measured with version 2.0 on a GitHub-hosted runner; the test suite also gates the 0 B. Allocation breakdown, design notes and full numbers: docs/performance.md.
- Documentation: notify.zeroalloc.net
- Runnable example:
samples/ZeroAlloc.Notify.AotSmoke, published with NativeAOT in CI - Related packages: ZeroAlloc.AsyncEvents and the rest of the ZeroAlloc family
- Contributing: issues and pull requests are welcome on GitHub
- License: MIT