Zomp.SyncMethodGenerator
1.0.5
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Zomp.SyncMethodGenerator --version 1.0.5
NuGet\Install-Package Zomp.SyncMethodGenerator -Version 1.0.5
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="Zomp.SyncMethodGenerator" Version="1.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Zomp.SyncMethodGenerator" Version="1.0.5" />
<PackageReference Include="Zomp.SyncMethodGenerator" />
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 Zomp.SyncMethodGenerator --version 1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Zomp.SyncMethodGenerator, 1.0.5"
#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.
#addin nuget:?package=Zomp.SyncMethodGenerator&version=1.0.5
#tool nuget:?package=Zomp.SyncMethodGenerator&version=1.0.5
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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
foreachstatementChange 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
Asyncsuffix from method calls (e.g. MoveNextAsync becomes MoveNext) - Remove CancellationToken parameter
- Remove IProgress<T>.Report(T) call
- Remove Memory<T>.Span property
Remove
CreateSyncVersionAttributeUpdate XML documentation
Installation
To add the library use:
dotnet add package Zomp.SyncMethodGenerator
There are no supported framework assets in this package.
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 (3)
Showing the top 3 popular GitHub repositories that depend on Zomp.SyncMethodGenerator:
| Repository | Stars |
|---|---|
|
FluentValidation/FluentValidation
A popular .NET validation library for building strongly-typed validation rules.
|
|
|
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
|
|
|
AvionBlock/VoiceCraft
VoiceCraft software to implement proximity VC for Minecraft Bedrock Edition
|
| Version | Downloads | Last updated |
|---|---|---|
| 1.4.20 | 217 | 3/9/2025 |
| 1.4.18 | 163 | 2/24/2025 |
| 1.4.15 | 564 | 11/17/2024 |
| 1.4.14 | 1,231 | 8/7/2024 |
| 1.4.13 | 858 | 7/21/2024 |
| 1.4.11 | 707 | 7/15/2024 |
| 1.4.10 | 625 | 7/13/2024 |
| 1.4.8 | 286 | 7/8/2024 |
| 1.4.3 | 244 | 6/27/2024 |
| 1.4.1 | 267 | 5/21/2024 |
| 1.3.44 | 212 | 5/14/2024 |
| 1.3.43 | 287 | 4/26/2024 |
| 1.3.40 | 496 | 4/11/2024 |
| 1.3.39 | 244 | 4/9/2024 |
| 1.3.38 | 377 | 3/23/2024 |
| 1.3.36 | 212 | 3/20/2024 |
| 1.3.35 | 94 | 3/19/2024 |
| 1.3.33 | 169 | 3/18/2024 |
| 1.3.28 | 166 | 3/18/2024 |
| 1.3.27 | 193 | 3/17/2024 |
| 1.3.24 | 416 | 3/12/2024 |
| 1.3.23 | 235 | 3/12/2024 |
| 1.3.21 | 194 | 3/11/2024 |
| 1.3.20 | 226 | 3/11/2024 |
| 1.3.18 | 194 | 3/10/2024 |
| 1.3.17 | 272 | 2/26/2024 |
| 1.3.16 | 308 | 2/26/2024 |
| 1.3.13 | 222 | 2/25/2024 |
| 1.3.8-beta | 562 | 2/12/2024 |
| 1.3.6 | 289 | 1/26/2024 |
| 1.3.5 | 207 | 1/21/2024 |
| 1.3.1 | 305 | 1/17/2024 |
| 1.2.24 | 217 | 1/14/2024 |
| 1.2.18 | 185 | 1/5/2024 |
| 1.2.16 | 217 | 1/5/2024 |
| 1.2.13 | 190 | 1/4/2024 |
| 1.2.12 | 186 | 1/4/2024 |
| 1.2.8 | 188 | 1/3/2024 |
| 1.2.3 | 433 | 11/20/2023 |
| 1.2.1 | 197 | 11/13/2023 |
| 1.1.2 | 2,383 | 8/8/2023 |
| 1.0.14 | 271 | 8/4/2023 |
| 1.0.12 | 31,580 | 8/3/2023 |
| 1.0.11 | 242 | 8/2/2023 |
| 1.0.5 | 165 | 7/31/2023 |
| 1.0.3 | 154 | 7/29/2023 |
| 1.0.2 | 170 | 7/29/2023 |
| 1.0.1 | 243 | 7/27/2023 |
| 0.1.39-alpha | 520 | 1/25/2023 |
| 0.1.38-alpha | 249 | 1/19/2023 |
| 0.1.37-alpha | 243 | 1/19/2023 |
| 0.1.34-alpha | 233 | 1/18/2023 |
| 0.1.33-alpha | 213 | 1/15/2023 |
| 0.1.30-alpha | 274 | 11/21/2022 |
| 0.1.22-alpha | 235 | 11/19/2022 |
| 0.1.21-alpha | 232 | 11/19/2022 |
| 0.1.19-alpha | 208 | 11/19/2022 |
| 0.1.18-alpha | 243 | 11/18/2022 |
| 0.1.17-alpha | 313 | 11/14/2022 |
| 0.1.13-alpha | 219 | 11/13/2022 |
| 0.1.12-alpha | 262 | 10/31/2022 |
| 0.1.10-alpha | 211 | 10/28/2022 |
| 0.1.9-alpha | 257 | 10/27/2022 |
| 0.1.8-alpha | 283 | 10/27/2022 |
| 0.1.5-alpha | 234 | 10/27/2022 |
| 0.1.4-alpha | 260 | 10/27/2022 |
| 0.1.3-alpha | 281 | 10/26/2022 |
| 0.1.2-alpha | 281 | 10/25/2022 |
| 0.1.1-alpha | 306 | 10/25/2022 |