Zomp.SyncMethodGenerator 0.1.30-alpha

This is a prerelease version of Zomp.SyncMethodGenerator.

There is a newer version of this package available.
See the version list below for details.

dotnet add package Zomp.SyncMethodGenerator --version 0.1.30-alpha

NuGet\Install-Package Zomp.SyncMethodGenerator -Version 0.1.30-alpha

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="0.1.30-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Zomp.SyncMethodGenerator" Version="0.1.30-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="Zomp.SyncMethodGenerator" />
                    

                            Project file

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 0.1.30-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Zomp.SyncMethodGenerator, 0.1.30-alpha"

#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.

#:package Zomp.SyncMethodGenerator@0.1.30-alpha

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Zomp.SyncMethodGenerator&version=0.1.30-alpha&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Zomp.SyncMethodGenerator&version=0.1.30-alpha&prerelease
                    

                            Install as a Cake Tool

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 foreach statement
Change 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
- CancellationToken
- IProgress<T>
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

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>

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 (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.	9.8K
mini-software/MiniExcel Lightweight, fast and simple cross-platform .NET processing tool for importing and exporting spreadsheet documents	3.5K
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	570
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.	117

Version	Downloads	Last Updated
2.0.42	1,194	7/28/2026
2.0.41	111	7/28/2026
2.0.40	136	7/28/2026
2.0.38	105	7/28/2026
2.0.35	106	7/27/2026
2.0.33	113	7/27/2026
2.0.32	150	7/27/2026
2.0.20	112	7/27/2026
2.0.16	1,449	6/26/2026
2.0.15	240	6/25/2026
2.0.13	2,219	4/29/2026
2.0.8	2,086	3/1/2026
2.0.7	12,537	12/24/2025
2.0.5	494	12/15/2025
2.0.4	392	11/27/2025
2.0.3	285	11/27/2025
2.0.2	262	11/24/2025
2.0.1	280	11/24/2025
1.6.17	1,777	7/28/2025
0.1.30-alpha	438	11/21/2022