Metalama.Community.AutoCancellationToken
2025.1.2-preview
Prefix Reserved
This is a prerelease version of Metalama.Community.AutoCancellationToken.
dotnet add package Metalama.Community.AutoCancellationToken --version 2025.1.2-preview
NuGet\Install-Package Metalama.Community.AutoCancellationToken -Version 2025.1.2-preview
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="Metalama.Community.AutoCancellationToken" Version="2025.1.2-preview" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Metalama.Community.AutoCancellationToken" Version="2025.1.2-preview" />
<PackageReference Include="Metalama.Community.AutoCancellationToken" />
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 Metalama.Community.AutoCancellationToken --version 2025.1.2-preview
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Metalama.Community.AutoCancellationToken, 2025.1.2-preview"
#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=Metalama.Community.AutoCancellationToken&version=2025.1.2-preview&prerelease
#tool nuget:?package=Metalama.Community.AutoCancellationToken&version=2025.1.2-preview&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Metalama.Community.AutoCancellationToken
Automatically propagates CancellationToken parameter to async methods and method calls within them.
This is a Metalama aspect. It modifies your code during compilation by using source weaving.
Example
Your code:
[AutoCancellationToken]
class C
{
async Task MakeRequests(CancellationToken ct)
{
using var client = new HttpClient();
await MakeRequest(client);
}
private static async Task MakeRequest(HttpClient client) => await client.GetAsync("https://example.org");
}
What gets compiled:
class C
{
async Task MakeRequests(CancellationToken ct)
{
using var client = new HttpClient();
await MakeRequest(client, ct);
}
private static async Task MakeRequest(HttpClient client, CancellationToken cancellationToken = default) => await client.GetAsync("https://example.org", cancellationToken);
}
Notice that CancellationToken parameter was added to the declaration of MakeRequest and that CancellationToken
argument was added to the calls of MakeRequest and HttpClient.GetAsync.
Installation
Install the NuGet package: dotnet add package Metalama.Community.AutoCancellationToken.
How to use
Add [AutoCancellationToken] to the types where you want it to apply.
By annotating a type with [AutoCancellationToken], you add cancellation to all its async methods. Specifically:
- A
CancellationTokenparameter is added to allasyncmethods that don't have it. - A
CancelltionTokenargument is added to calls withinasyncmethods where:CancellationTokencan be added as a last argument and the added argument corresponds to aCancellationTokenparameter (e.g. it's not aparams object[]parameter or a generic parameter). The added argument can result in calling a different overload of the method, or specifying a value for an optional parameter.- The call is not in a
staticlocal function. - The containing method doesn't have two or more
CancellationTokenparameters, since it wouldn't be clear which one to use.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Metalama.Framework (>= 2025.1.2-preview)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Metalama.Community.AutoCancellationToken:
| Package | Downloads |
|---|---|
|
Shinya.Core
Shinya.Framework |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated |
|---|---|---|
| 2025.1.2-preview | 33 | 4/1/2025 |
| 2025.1.1-preview | 163 | 3/18/2025 |
| 2025.0.10 | 60 | 3/31/2025 |
| 2025.0.9 | 235 | 3/7/2025 |
| 2025.0.8 | 274 | 1/6/2025 |
| 2025.0.7-rc | 204 | 12/6/2024 |
| 2025.0.6-rc | 207 | 11/15/2024 |
| 2025.0.5-preview | 109 | 11/8/2024 |
| 2025.0.3-preview | 89 | 10/25/2024 |
| 2025.0.2-preview | 79 | 10/24/2024 |
| 2025.0.1-preview | 72 | 10/14/2024 |
| 2024.2.32 | 172 | 3/7/2025 |
| 2024.2.31 | 97 | 12/6/2024 |
| 2024.2.30 | 100 | 11/15/2024 |
| 2024.2.29 | 94 | 10/31/2024 |
| 2024.2.27 | 91 | 10/25/2024 |
| 2024.2.26 | 79 | 10/24/2024 |
| 2024.2.25 | 130 | 10/14/2024 |
| 2024.2.24 | 106 | 10/2/2024 |
| 2024.2.23 | 134 | 9/10/2024 |
| 2024.2.22 | 107 | 8/29/2024 |
| 2024.2.21 | 111 | 8/28/2024 |
| 2024.2.20 | 132 | 8/15/2024 |
| 2024.2.19 | 1,329 | 8/1/2024 |
| 2024.2.18 | 88 | 7/29/2024 |
| 2024.2.17-rc | 104 | 7/22/2024 |
| 2024.2.16-rc | 89 | 7/18/2024 |
| 2024.2.15-rc | 76 | 7/12/2024 |
| 2024.2.14-rc | 2,524 | 7/8/2024 |
| 2024.2.13-rc | 92 | 7/2/2024 |
| 2024.2.12-preview | 86 | 6/28/2024 |
| 2024.2.11-preview | 86 | 6/26/2024 |
| 2024.2.10-preview | 104 | 6/20/2024 |
| 2024.2.9-preview | 92 | 6/11/2024 |
| 2024.2.8-preview | 85 | 6/6/2024 |
| 2024.2.7-preview | 111 | 5/30/2024 |
| 2024.2.6-preview | 101 | 5/25/2024 |
| 2024.2.5-preview | 111 | 5/6/2024 |
| 2024.2.4-preview | 114 | 5/4/2024 |
| 2024.2.3-preview | 107 | 4/30/2024 |
| 2024.2.2-preview | 101 | 4/23/2024 |
| 2024.2.1-preview | 91 | 4/11/2024 |
| 2024.1.30 | 86 | 10/24/2024 |
| 2024.1.29 | 97 | 10/11/2024 |
| 2024.1.28 | 120 | 9/9/2024 |
| 2024.1.27 | 98 | 8/28/2024 |
| 2024.1.26 | 106 | 8/15/2024 |
| 2024.1.25 | 113 | 7/22/2024 |
| 2024.1.24 | 88 | 7/12/2024 |
| 2024.1.23 | 2,672 | 6/26/2024 |
| 2024.1.22 | 95 | 6/15/2024 |
| 2024.1.21 | 110 | 6/6/2024 |
| 2024.1.20 | 115 | 5/30/2024 |
| 2024.1.19 | 116 | 5/24/2024 |
| 2024.1.18 | 154 | 5/6/2024 |
| 2024.1.17 | 86 | 5/3/2024 |
| 2024.1.16 | 123 | 4/30/2024 |
| 2024.1.15 | 110 | 4/29/2024 |
| 2024.1.14 | 114 | 4/23/2024 |
| 2024.1.13 | 126 | 4/23/2024 |
| 2024.1.12 | 144 | 4/17/2024 |
| 2024.1.11-rc | 101 | 4/11/2024 |
| 2024.1.10-rc | 123 | 4/4/2024 |
| 2024.1.9-rc | 103 | 3/27/2024 |
| 2024.1.8-preview | 92 | 3/25/2024 |
| 2024.1.7-preview | 107 | 3/19/2024 |
| 2024.1.6-preview | 101 | 3/6/2024 |
| 2024.1.5-preview | 103 | 2/29/2024 |
| 2024.1.4-preview | 104 | 2/27/2024 |
| 2024.1.3-preview | 102 | 2/23/2024 |
| 2024.1.2-preview | 136 | 2/7/2024 |
| 2024.1.1-preview | 116 | 1/30/2024 |
| 2024.0.16 | 104 | 6/15/2024 |
| 2024.0.15 | 116 | 6/6/2024 |
| 2024.0.14 | 109 | 5/30/2024 |
| 2024.0.13 | 109 | 5/24/2024 |
| 2024.0.12 | 131 | 4/17/2024 |
| 2024.0.11 | 132 | 3/21/2024 |
| 2024.0.10 | 108 | 3/19/2024 |
| 2024.0.9 | 146 | 2/29/2024 |
| 2024.0.8 | 164 | 2/23/2024 |
| 2024.0.7 | 164 | 2/7/2024 |
| 2024.0.6 | 219 | 1/3/2024 |
| 2024.0.5-rc | 128 | 12/21/2023 |
| 2024.0.4-rc | 149 | 12/12/2023 |
| 2024.0.3-preview | 148 | 12/6/2023 |
| 2024.0.2-preview | 155 | 11/14/2023 |
| 2024.0.1-preview | 132 | 11/6/2023 |
| 2023.4.9 | 118 | 2/7/2024 |
| 2023.4.8 | 146 | 12/21/2023 |
| 2023.4.7 | 169 | 12/12/2023 |
| 2023.4.6 | 187 | 11/7/2023 |
| 2023.4.5-rc | 144 | 10/26/2023 |
| 2023.4.4-preview | 144 | 10/18/2023 |
| 2023.4.3-preview | 140 | 10/4/2023 |
| 2023.4.2-preview | 135 | 9/26/2023 |
| 2023.4.1-preview | 137 | 9/13/2023 |
| 2023.3.10 | 130 | 12/21/2023 |
| 2023.3.9 | 155 | 12/12/2023 |
| 2023.3.8 | 165 | 10/17/2023 |
| 2023.3.7-rc | 148 | 9/29/2023 |
| 2023.3.6-rc | 155 | 9/26/2023 |
| 2023.3.5-rc | 154 | 9/13/2023 |
| 2023.3.4-preview | 163 | 8/30/2023 |
| 2023.3.3-preview | 165 | 8/29/2023 |
| 2023.3.2-preview | 382 | 8/1/2023 |
| 2023.3.1-preview | 282 | 7/28/2023 |
| 2023.2.5 | 378 | 9/12/2023 |
| 2023.2.4 | 341 | 8/7/2023 |
| 2023.2.3-rc | 317 | 8/3/2023 |
| 2023.2.2-rc | 322 | 7/21/2023 |
| 2023.2.1-preview | 357 | 6/27/2023 |
| 2023.1.7 | 343 | 9/12/2023 |
| 2023.1.6 | 367 | 8/7/2023 |
| 2023.1.5 | 202 | 7/17/2023 |
| 2023.1.4 | 228 | 6/27/2023 |