Add AsyncContinueOnCapturedContext to SepReaderOptions/SepWriterOptions (forward to ConfigureAwait)

.editorconfig

@@ -288,7 +288,7 @@ dotnet_diagnostic.CA1851.severity = warning
 dotnet_diagnostic.CA1834.severity = warning
 
 # CA2007: Do not directly await a Task
-dotnet_diagnostic.CA2007.severity = none
+dotnet_diagnostic.CA2007.severity = warning
 
 # CA2008: Do not create tasks without passing a TaskScheduler
 dotnet_diagnostic.CA2008.severity = warning

README.md

@@ -348,6 +348,12 @@ public bool Unescape { get; init; } = false;
 /// 32) character is trimmed, not any whitespace character.
 /// </remarks>
 public SepTrim Trim { get; init; } = SepTrim.None;
+/// <summary>
+/// Forwarded to <see
+/// cref="System.Threading.Tasks.ValueTask.ConfigureAwait(bool)"/> or
+/// similar when async methods are called.
+/// </summary>
+public bool AsyncContinueOnCapturedContext { get; init; } = false;
 ```
 
 #### Unescaping
@@ -867,6 +873,12 @@ public SepColNotSetOption ColNotSetOption { get; init; } = SepColNotSetOption.Th
 /// too, but only the written name.
 /// </remarks>
 public bool Escape { get; init; } = false;
+/// <summary>
+/// Forwarded to <see
+/// cref="System.Threading.Tasks.ValueTask.ConfigureAwait(bool)"/> or
+/// similar when async methods are called.
+/// </summary>
+public bool AsyncContinueOnCapturedContext { get; init; } = false;
 ```
 
 #### Escaping
@@ -2056,6 +2068,7 @@ namespace nietras.SeparatedValues
     {
         public SepReaderOptions() { }
         public SepReaderOptions(nietras.SeparatedValues.Sep? sep) { }
+        public bool AsyncContinueOnCapturedContext { get; init; }
         public System.Collections.Generic.IEqualityComparer<string> ColNameComparer { get; init; }
         public nietras.SeparatedValues.SepCreateToString CreateToString { get; init; }
         public System.Globalization.CultureInfo? CultureInfo { get; init; }
@@ -2219,6 +2232,7 @@ namespace nietras.SeparatedValues
     {
         public SepWriterOptions() { }
         public SepWriterOptions(nietras.SeparatedValues.Sep sep) { }
+        public bool AsyncContinueOnCapturedContext { get; init; }
         public nietras.SeparatedValues.SepColNotSetOption ColNotSetOption { get; init; }
         public System.Globalization.CultureInfo? CultureInfo { get; init; }
         public bool DisableColCountCheck { get; init; }

src/Sep.ComparisonBenchmarks/Sep.ComparisonBenchmarks.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <RootNamespace>nietras.SeparatedValues.Benchmarks</RootNamespace>
     <OutputType>Exe</OutputType>
+    <NoWarn>$(NoWarn);CA2007</NoWarn>
   </PropertyGroup>
 
   <PropertyGroup>

src/Sep.Test/Sep.Test.csproj

@@ -4,6 +4,7 @@
     <RootNamespace>nietras.SeparatedValues.Test</RootNamespace>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <IsPackable>false</IsPackable>
+    <NoWarn>$(NoWarn);CA2007</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

src/Sep.Test/SepReaderOptionsTest.cs

@@ -19,6 +19,7 @@ public void SepReaderOptionsTest_Defaults()
         Assert.AreSame(SepToString.Direct, sut.CreateToString);
         Assert.IsFalse(sut.DisableFastFloat);
         Assert.IsFalse(sut.DisableColCountCheck);
+        Assert.IsFalse(sut.AsyncContinueOnCapturedContext);
     }
 
     [TestMethod]
@@ -34,6 +35,7 @@ public void SepReaderOptionsTest_Override()
             CreateToString = SepToString.OnePool(),
             DisableFastFloat = true,
             DisableColCountCheck = true,
+            AsyncContinueOnCapturedContext = true,
         };
 
         Assert.AreEqual(new Sep(','), sut.Sep);
@@ -44,5 +46,6 @@ public void SepReaderOptionsTest_Override()
         Assert.AreNotSame(SepToString.Direct, sut.CreateToString);
         Assert.IsTrue(sut.DisableFastFloat);
         Assert.IsTrue(sut.DisableColCountCheck);
+        Assert.IsTrue(sut.AsyncContinueOnCapturedContext);
     }
 }

src/Sep.Test/SepWriterOptionsTest.cs

@@ -16,5 +16,6 @@ public void SepWriterOptionsTest_Defaults()
         Assert.IsFalse(sut.DisableColCountCheck);
         Assert.AreEqual(SepColNotSetOption.Throw, sut.ColNotSetOption);
         Assert.IsFalse(sut.Escape);
+        Assert.IsFalse(sut.AsyncContinueOnCapturedContext);
     }
 }

src/Sep.XyzTest/Sep.XyzTest.csproj

@@ -4,6 +4,7 @@
     <RootNamespace>nietras.SeparatedValues.XyzTest</RootNamespace>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <IsPackable>false</IsPackable>
+    <NoWarn>$(NoWarn);CA2007</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

src/Sep/SepReader.IO.Async.cs

@@ -25,7 +25,7 @@ internal async ValueTask InitializeAsync(SepReaderOptions options, CancellationT
 #if SYNC
         if (MoveNext())
 #else
-        if (await MoveNextAsync(cancellationToken))
+        if (await MoveNextAsync(cancellationToken).ConfigureAwait(_continueOnCapturedContext))
 #endif
         {
             A.Assert(_parsedRowsCount > 0);
@@ -56,7 +56,8 @@ internal async ValueTask InitializeAsync(SepReaderOptions options, CancellationT
 #if SYNC
                     HasRows = !FillAndMaybeDoubleCharsBuffer(_charsPaddingLength);
 #else
-                    HasRows = !await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken);
+                    HasRows = !await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken)
+                        .ConfigureAwait(_continueOnCapturedContext);
 #endif
                 }
             }
@@ -111,7 +112,8 @@ public async ValueTask<bool> MoveNextAsync(CancellationToken cancellationToken =
 #if SYNC
         } while (ParseNewRows());
 #else
-        } while (await ParseNewRowsAsync(cancellationToken));
+        } while (await ParseNewRowsAsync(cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext));
 #endif
         return false;
     }
@@ -216,7 +218,8 @@ internal async ValueTask<bool> ParseNewRowsAsync(CancellationToken cancellationT
 #if SYNC
         endOfFile = EnsureInitializeAndReadData(endOfFile);
 #else
-        endOfFile = await EnsureInitializeAndReadDataAsync(endOfFile, cancellationToken);
+        endOfFile = await EnsureInitializeAndReadDataAsync(endOfFile, cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext);
 #endif
         if (endOfFile && _parsingRowCharsStartIndex < _charsDataEnd && _charsParseStart == _charsDataEnd)
         {
@@ -258,7 +261,8 @@ async ValueTask<bool> EnsureInitializeAndReadDataAsync(bool endOfFile, Cancellat
         var nothingLeftToRead = FillAndMaybeDoubleCharsBuffer(_charsPaddingLength);
         CheckPoint($"{nameof(FillAndMaybeDoubleCharsBuffer)} AFTER");
 #else
-        var nothingLeftToRead = await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken);
+        var nothingLeftToRead = await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext);
         CheckPoint($"{nameof(FillAndMaybeDoubleCharsBufferAsync)} AFTER");
 #endif
         if (_parser == null)
@@ -322,7 +326,8 @@ async ValueTask<bool> FillAndMaybeDoubleCharsBufferAsync(int paddingLength, Canc
                ((readCount = _reader.Read(freeChars.Slice(totalBytesRead))) > 0))
 #else
         while (totalBytesRead < freeLength &&
-                ((readCount = await _reader.ReadAsync(freeChars.Slice(totalBytesRead), cancellationToken)) > 0))
+                ((readCount = await _reader.ReadAsync(freeChars.Slice(totalBytesRead), cancellationToken)
+                    .ConfigureAwait(_continueOnCapturedContext)) > 0))
 #endif
         {
             _charsDataEnd += readCount;

src/Sep/SepReader.IO.Sync.cs

@@ -25,7 +25,7 @@ internal async ValueTask InitializeAsync(SepReaderOptions options, CancellationT
 #if SYNC
         if (MoveNext())
 #else
-        if (await MoveNextAsync(cancellationToken))
+        if (await MoveNextAsync(cancellationToken).ConfigureAwait(_continueOnCapturedContext))
 #endif
         {
             A.Assert(_parsedRowsCount > 0);
@@ -56,7 +56,8 @@ internal async ValueTask InitializeAsync(SepReaderOptions options, CancellationT
 #if SYNC
                     HasRows = !FillAndMaybeDoubleCharsBuffer(_charsPaddingLength);
 #else
-                    HasRows = !await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken);
+                    HasRows = !await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken)
+                        .ConfigureAwait(_continueOnCapturedContext);
 #endif
                 }
             }
@@ -111,7 +112,8 @@ public async ValueTask<bool> MoveNextAsync(CancellationToken cancellationToken =
 #if SYNC
         } while (ParseNewRows());
 #else
-        } while (await ParseNewRowsAsync(cancellationToken));
+        } while (await ParseNewRowsAsync(cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext));
 #endif
         return false;
     }
@@ -216,7 +218,8 @@ internal async ValueTask<bool> ParseNewRowsAsync(CancellationToken cancellationT
 #if SYNC
         endOfFile = EnsureInitializeAndReadData(endOfFile);
 #else
-        endOfFile = await EnsureInitializeAndReadDataAsync(endOfFile, cancellationToken);
+        endOfFile = await EnsureInitializeAndReadDataAsync(endOfFile, cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext);
 #endif
         if (endOfFile && _parsingRowCharsStartIndex < _charsDataEnd && _charsParseStart == _charsDataEnd)
         {
@@ -258,7 +261,8 @@ async ValueTask<bool> EnsureInitializeAndReadDataAsync(bool endOfFile, Cancellat
         var nothingLeftToRead = FillAndMaybeDoubleCharsBuffer(_charsPaddingLength);
         CheckPoint($"{nameof(FillAndMaybeDoubleCharsBuffer)} AFTER");
 #else
-        var nothingLeftToRead = await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken);
+        var nothingLeftToRead = await FillAndMaybeDoubleCharsBufferAsync(_charsPaddingLength, cancellationToken)
+            .ConfigureAwait(_continueOnCapturedContext);
         CheckPoint($"{nameof(FillAndMaybeDoubleCharsBufferAsync)} AFTER");
 #endif
         if (_parser == null)
@@ -322,7 +326,8 @@ async ValueTask<bool> FillAndMaybeDoubleCharsBufferAsync(int paddingLength, Canc
                ((readCount = _reader.Read(freeChars.Slice(totalBytesRead))) > 0))
 #else
         while (totalBytesRead < freeLength &&
-                ((readCount = await _reader.ReadAsync(freeChars.Slice(totalBytesRead), cancellationToken)) > 0))
+                ((readCount = await _reader.ReadAsync(freeChars.Slice(totalBytesRead), cancellationToken)
+                    .ConfigureAwait(_continueOnCapturedContext)) > 0))
 #endif
         {
             _charsDataEnd += readCount;

src/Sep/SepReader.cs

@@ -32,6 +32,7 @@ public sealed partial class SepReader : SepReaderState
     readonly Info _info;
     char _separator;
     readonly bool _disableQuotesParsing;
+    readonly bool _continueOnCapturedContext;
     readonly TextReader _reader;
     ISepParser? _parser;
 
@@ -46,6 +47,7 @@ internal SepReader(Info info, in SepReaderOptions options, TextReader reader)
         _cultureInfo = options.CultureInfo;
         _createToString = options.CreateToString;
         _disableQuotesParsing = options.DisableQuotesParsing;
+        _continueOnCapturedContext = options.AsyncContinueOnCapturedContext;
         _arrayPool = new();
 
         var decimalSeparator = _cultureInfo?.NumberFormat.CurrencyDecimalSeparator ??

src/Sep/SepReaderExtensions.IO.Async.cs

@@ -1,4 +1,5 @@
 //#define SYNC
+#pragma warning disable CA2007
 using System;
 using System.IO;
 #if !SYNC

src/Sep/SepReaderExtensions.IO.Sync.cs

@@ -1,4 +1,5 @@
 #define SYNC
+#pragma warning disable CA2007
 using System;
 using System.IO;
 #if !SYNC

src/Sep/SepReaderOptions.cs

@@ -96,4 +96,10 @@ public SepReaderOptions(Sep? sep)
     /// 32) character is trimmed, not any whitespace character.
     /// </remarks>
     public SepTrim Trim { get; init; } = SepTrim.None;
+    /// <summary>
+    /// Forwarded to <see
+    /// cref="System.Threading.Tasks.ValueTask.ConfigureAwait(bool)"/> or
+    /// similar when async methods are called.
+    /// </summary>
+    public bool AsyncContinueOnCapturedContext { get; init; } = false;
 }