ZeroAlloc.Notify.Generator 1.1.0

ZeroAlloc.Notify

ZeroAlloc.Notify is a source-generated notification library for .NET 8 and .NET 10. It provides async-first property and collection change notifications without reflection or dynamic dispatch. The Roslyn source generator eliminates runtime overhead by wiring all dispatch at compile time — no virtual dispatch, fully awaitable handlers.

Install

The source generator is bundled into the main package — a single PackageReference is all you need:

dotnet add package ZeroAlloc.Notify

The standalone ZeroAlloc.Notify.Generator package is still published for backwards compatibility with existing direct PackageReferences, but new consumers should reference only ZeroAlloc.Notify.

Quick Example

// 1. Define a ViewModel with observable properties
[NotifyPropertyChangedAsync]
public partial class UserViewModel
{
    [ObservableProperty]
    private string _name = "";

    [ObservableProperty]
    private int _age;
}

// 2. Subscribe to async notifications
var vm = new UserViewModel();
vm.PropertyChangedAsync += async (args, ct) =>
{
    Console.WriteLine($"Property '{args.PropertyName}' changed from {args.OldValue} to {args.NewValue}");
    await Task.Delay(100, ct); // Non-blocking handler execution
};

// 3. Set properties — fully awaitable
await vm.SetNameAsync("Alice");
await vm.SetAgeAsync(30);

Performance

ZeroAlloc.Notify provides async-first, fully awaitable handler dispatch — the only framework in this comparison where await vm.SetNameAsync(...) truly awaits all handlers. The async path runs at competitive speed with modest allocation (.NET 10, i9-12900HK, BenchmarkDotNet).

CommunityToolkit.Mvvm and PropertyChanged.Fody support sync notifications only — they cannot await async handlers. ZeroAlloc.Notify is the only framework in this comparison with first-class ValueTask handler dispatch.

See docs/performance.md for detailed benchmark results and zero-allocation design explanation.

Features

• Property Notifications — Strongly-typed, fully async PropertyChangedAsync events
• Collection Changes — CollectionChangedAsync with observable property support
• Data Validation — INotifyDataErrorInfoAsync for async error collection
• Sequential & Parallel — [InvokeSequentially] attribute for handler ordering
• Compiler Diagnostics — Missing handlers and misconfigurations caught at build time
• Async-First — Fully awaitable ValueTask handlers; no fire-and-forget, no callbacks
• Native AOT Compatible — No reflection at runtime; all dispatch resolved at compile time
• Source Generated — Full type safety with compile-time verification

Documentation

Examples

See the samples directory for complete working examples:

• WPF MVVM application
• ASP.NET Core data binding
• Console property notifications
• Collection change handling

License

MIT