Skip to content

Point at SharpCompress as a worked example #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
virzak merged 2 commits into from
Jul 28, 2026
Merged

Point at SharpCompress as a worked example #156

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98278b7
Point at SharpCompress as a worked example
virzak Jul 28, 2026
daaa881
List FluentValidation and MiniExcel too
virzak Jul 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ This [.NET source generator](https://learn.microsoft.com/en-us/dotnet/csharp/ros
- Large data from I/O which cannot be stored in memory before processing: Original async method
- Small sample of data in memory, usually a sample of the larger data: Generated sync method

## Used by

- [FluentValidation](https://github.com/FluentValidation/FluentValidation) - validation library
- [MiniExcel](https://github.com/mini-software/MiniExcel) - spreadsheet reader and writer
- [SharpCompress](https://github.com/adamhathcock/sharpcompress) - compression library

SharpCompress's [migration notes](https://github.com/adamhathcock/sharpcompress/blob/master/docs/SYNC_METHOD_GENERATION.md) are worth reading before adopting this in a codebase which already has both halves written by hand. They cover how to prove that a generated method is the one it replaces, and when attributing a method would add a member rather than remove a duplicate - a generated `Read(Span<byte>)` displaces the shim `Stream` provides, which is a change in behaviour rather than a deduplication.

## How it works

### CreateSyncVersionAttribute on a method
Expand Down
Loading