Zomp.SyncMethodGenerator
0.1.19-alpha
See the version list below for details.
dotnet add package Zomp.SyncMethodGenerator --version 0.1.19-alpha
NuGet\Install-Package Zomp.SyncMethodGenerator -Version 0.1.19-alpha
<PackageReference Include="Zomp.SyncMethodGenerator" Version="0.1.19-alpha" />
<PackageVersion Include="Zomp.SyncMethodGenerator" Version="0.1.19-alpha" />
<PackageReference Include="Zomp.SyncMethodGenerator" />
paket add Zomp.SyncMethodGenerator --version 0.1.19-alpha
#r "nuget: Zomp.SyncMethodGenerator, 0.1.19-alpha"
#:package Zomp.SyncMethodGenerator@0.1.19-alpha
#addin nuget:?package=Zomp.SyncMethodGenerator&version=0.1.19-alpha&prerelease
#tool nuget:?package=Zomp.SyncMethodGenerator&version=0.1.19-alpha&prerelease
Sync Method Generator
This .NET source generator produces a sync method from an async one.
Use cases
- A library which exposes both sync and async version of a method
- An application has to process two kinds of data in the same way:
- 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
How it works
Add CreateSyncVersionAttribute
to your async method in your partial
class
[Zomp.SyncMethodGenerator.CreateSyncVersion]
static async Task WriteAsync(ReadOnlyMemory<byte> buffer, Stream stream,
CancellationToken ct)
=> await stream.WriteAsync(buffer, ct).ConfigureAwait(true);
And it will generate a sync version of the method:
static void Write(ReadOnlySpan<byte> buffer, Stream stream)
=> stream.Write(buffer);
A list of changes applied to the new synchronized method:
Remove async modifier
Remove await from methods as well as
foreach
statementChange types
From To Task or ValueTask void Task<T> or ValueTask<T> T IAsyncEnumerable<T> IEnumerable<T> IAsyncEnumerator<T> IEnumerator<T> Memory<T> Span<T> ReadOnlyMemory<T> ReadOnlySpan<T> Remove parameters
Invocation changes
- Remove ConfigureAwait
- Remove WithCancellation
- Remove
Async
suffix from method calls (e.g. MoveNextAsync becomes MoveNext) - Remove CancellationToken parameter
- Remove IProgress<T>.Report(T) call
- Remove Memory<T>.Span property
Remove
CreateSyncVersionAttribute
Update XML documentation
Installation
To add the library use:
dotnet add package Zomp.SyncMethodGenerator
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 (4)
Showing the top 4 popular GitHub repositories that depend on Zomp.SyncMethodGenerator:
Repository | Stars |
---|---|
FluentValidation/FluentValidation
A popular .NET validation library for building strongly-typed validation rules.
|
|
mini-software/MiniExcel
Fast, Low-Memory, Easy Excel .NET helper to import/export/template spreadsheet (support Linux, Mac)
|
|
Zeugma440/atldotnet
Fully managed, portable and easy-to-use C# library to read and edit audio data and metadata (tags) from various audio formats, playlists and CUE sheets
|
|
BigBang1112/gbx-net
General purpose library for Gbx files - data from Nadeo games like Trackmania or Shootmania, written in C#/.NET. It supports high performance serialization and deserialization of 400+ Gbx classes.
|
Version | Downloads | Last Updated | |
---|---|---|---|
1.6.17 | 765 | 7/28/2025 | |
1.6.16 | 127 | 7/28/2025 | |
1.6.15 | 218 | 7/28/2025 | |
1.6.14 | 151 | 7/27/2025 | |
1.6.13 | 144 | 7/27/2025 | |
1.6.12 | 238 | 7/26/2025 | |
1.6.11 | 517 | 7/24/2025 | |
1.6.10 | 913 | 7/24/2025 | |
1.6.9 | 581 | 7/23/2025 | |
1.6.8 | 355 | 7/20/2025 | |
1.6.3 | 177 | 7/17/2025 | |
1.6.2 | 918 | 7/8/2025 | |
1.6.1 | 171 | 7/8/2025 | |
1.5.3 | 184 | 7/4/2025 | |
1.5.1 | 260 | 6/29/2025 | |
1.4.38 | 184 | 6/23/2025 | |
1.4.37 | 255 | 6/23/2025 | |
1.4.35 | 182 | 6/17/2025 | |
1.4.32 | 310 | 6/17/2025 | |
1.4.30 | 654 | 6/14/2025 | |
1.4.29 | 546 | 6/12/2025 | |
1.4.28 | 336 | 6/11/2025 | |
1.4.27 | 321 | 6/11/2025 | |
1.4.26 | 540 | 6/11/2025 | |
1.4.25 | 544 | 6/10/2025 | |
1.4.20 | 557 | 3/9/2025 | |
1.4.18 | 228 | 2/24/2025 | |
1.4.15 | 631 | 11/17/2024 | |
1.4.14 | 1,974 | 8/7/2024 | |
1.4.13 | 1,018 | 7/21/2024 | |
1.4.11 | 763 | 7/15/2024 | |
1.4.10 | 691 | 7/13/2024 | |
1.4.8 | 357 | 7/8/2024 | |
1.4.3 | 298 | 6/27/2024 | |
1.4.1 | 340 | 5/21/2024 | |
1.3.44 | 261 | 5/14/2024 | |
1.3.43 | 340 | 4/26/2024 | |
1.3.40 | 564 | 4/11/2024 | |
1.3.39 | 297 | 4/9/2024 | |
1.3.38 | 432 | 3/23/2024 | |
1.3.36 | 261 | 3/20/2024 | |
1.3.35 | 149 | 3/19/2024 | |
1.3.33 | 217 | 3/18/2024 | |
1.3.28 | 237 | 3/18/2024 | |
1.3.27 | 244 | 3/17/2024 | |
1.3.24 | 500 | 3/12/2024 | |
1.3.23 | 285 | 3/12/2024 | |
1.3.21 | 269 | 3/11/2024 | |
1.3.20 | 294 | 3/11/2024 | |
1.3.18 | 266 | 3/10/2024 | |
1.3.17 | 322 | 2/26/2024 | |
1.3.16 | 376 | 2/26/2024 | |
1.3.13 | 285 | 2/25/2024 | |
1.3.8-beta | 1,304 | 2/12/2024 | |
1.3.6 | 339 | 1/26/2024 | |
1.3.5 | 271 | 1/21/2024 | |
1.3.1 | 363 | 1/17/2024 | |
1.2.24 | 269 | 1/14/2024 | |
1.2.18 | 253 | 1/5/2024 | |
1.2.16 | 263 | 1/5/2024 | |
1.2.13 | 239 | 1/4/2024 | |
1.2.12 | 235 | 1/4/2024 | |
1.2.8 | 238 | 1/3/2024 | |
1.2.3 | 471 | 11/20/2023 | |
1.2.1 | 250 | 11/13/2023 | |
1.1.2 | 4,942 | 8/8/2023 | |
1.0.14 | 337 | 8/4/2023 | |
1.0.12 | 33,089 | 8/3/2023 | |
1.0.11 | 308 | 8/2/2023 | |
1.0.5 | 233 | 7/31/2023 | |
1.0.3 | 220 | 7/29/2023 | |
1.0.2 | 236 | 7/29/2023 | |
1.0.1 | 1,459 | 7/27/2023 | |
0.1.39-alpha | 615 | 1/25/2023 | |
0.1.38-alpha | 321 | 1/19/2023 | |
0.1.37-alpha | 320 | 1/19/2023 | |
0.1.34-alpha | 324 | 1/18/2023 | |
0.1.33-alpha | 289 | 1/15/2023 | |
0.1.30-alpha | 367 | 11/21/2022 | |
0.1.22-alpha | 307 | 11/19/2022 | |
0.1.21-alpha | 307 | 11/19/2022 | |
0.1.19-alpha | 280 | 11/19/2022 | |
0.1.18-alpha | 313 | 11/18/2022 | |
0.1.17-alpha | 390 | 11/14/2022 | |
0.1.13-alpha | 296 | 11/13/2022 | |
0.1.12-alpha | 334 | 10/31/2022 | |
0.1.10-alpha | 307 | 10/28/2022 | |
0.1.9-alpha | 335 | 10/27/2022 | |
0.1.8-alpha | 360 | 10/27/2022 | |
0.1.5-alpha | 329 | 10/27/2022 | |
0.1.4-alpha | 335 | 10/27/2022 | |
0.1.3-alpha | 368 | 10/26/2022 | |
0.1.2-alpha | 375 | 10/25/2022 | |
0.1.1-alpha | 385 | 10/25/2022 |