Make some API to be reusable by the derived classes

Author: sakno

src/DotNext.Threading/Threading/Tasks/ManualResetCompletionSource.cs

@@ -1,8 +1,9 @@
+using System.ComponentModel;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
-using ValueTaskSourceOnCompletedFlags = System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags;
+using System.Threading.Tasks.Sources;
 
 namespace DotNext.Threading.Tasks;
 
@@ -220,8 +221,26 @@ private void OnCompleted(in Continuation continuation, short token)
         throw new InvalidOperationException(errorMessage);
     }
 
-    [MethodImpl(MethodImplOptions.AggressiveInlining)]
-    private protected void OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
+    private protected ValueTaskSourceStatus GetStatus(short token, Exception? e)
+    {
+        var snapshot = versionAndStatus.VolatileRead(); // barrier to avoid reordering of result read
+
+        if (token != snapshot.Version)
+            throw new InvalidOperationException(ExceptionMessages.InvalidSourceToken);
+
+        return !snapshot.IsCompleted
+            ? ValueTaskSourceStatus.Pending
+            : e switch
+            {
+                null => ValueTaskSourceStatus.Succeeded,
+                OperationCanceledException => ValueTaskSourceStatus.Canceled,
+                _ => ValueTaskSourceStatus.Faulted,
+            };
+    }
+
+    /// <inheritdoc cref="IValueTaskSource.OnCompleted"/>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public void OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
         => OnCompleted(new(continuation, state, flags), token);
 
     /// <summary>

src/DotNext.Threading/Threading/Tasks/ValueTaskCompletionSource.T.cs

@@ -1,3 +1,4 @@
+using System.ComponentModel;
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks.Sources;
 using Debug = System.Diagnostics.Debug;
@@ -8,7 +9,7 @@ namespace DotNext.Threading.Tasks;
 /// Represents the producer side of <see cref="ValueTask{T}"/>.
 /// </summary>
 /// <remarks>
-/// In constrast to <see cref="TaskCompletionSource{T}"/>, this
+/// In contrast to <see cref="TaskCompletionSource{T}"/>, this
 /// source is resettable.
 /// From performance point of view, the type offers minimal or zero memory allocation
 /// for the task itself (excluding continuations). See <see cref="CreateTask(TimeSpan, CancellationToken)"/>
@@ -37,7 +38,7 @@ private static Result<T> FromCanceled(CancellationToken token)
         => new(new OperationCanceledException(token));
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="value">The value to be returned to the consumer.</param>
     /// <returns><see langword="true"/> if the result is completed successfully; <see langword="false"/> if the task has been canceled or timed out.</returns>
@@ -46,7 +47,7 @@ public bool TrySetResult(T value)
         => TrySetResult(null, value);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionData">The data to be saved in <see cref="ManualResetCompletionSource.CompletionData"/> property that can be accessed from within <see cref="ManualResetCompletionSource.AfterConsumed"/> method.</param>
     /// <param name="value">The value to be returned to the consumer.</param>
@@ -55,7 +56,7 @@ public unsafe bool TrySetResult(object? completionData, T value)
         => SetResult(completionData, completionToken: null, &Result.FromValue, value);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionToken">The completion token previously obtained from <see cref="CreateTask(TimeSpan, CancellationToken)"/> method.</param>
     /// <param name="value">The value to be returned to the consumer.</param>
@@ -65,7 +66,7 @@ public bool TrySetResult(short completionToken, T value)
         => TrySetResult(null, completionToken, value);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionData">The data to be saved in <see cref="ManualResetCompletionSource.CompletionData"/> property that can be accessed from within <see cref="ManualResetCompletionSource.AfterConsumed"/> method.</param>
     /// <param name="completionToken">The completion token previously obtained from <see cref="CreateTask(TimeSpan, CancellationToken)"/> method.</param>
@@ -219,7 +220,7 @@ ValueTask<T> ISupplier<TimeSpan, CancellationToken, ValueTask<T>>.Invoke(TimeSpa
     ValueTask ISupplier<TimeSpan, CancellationToken, ValueTask>.Invoke(TimeSpan timeout, CancellationToken token)
         => Activate(timeout, token) is { } version ? new(this, version) : throw new InvalidOperationException(ExceptionMessages.InvalidSourceState);
 
-    private T GetResult(short token)
+    private protected T GetResult(short token)
     {
         // ensure that instance field access before returning to the pool to avoid
         // concurrency with Reset()
@@ -236,35 +237,10 @@ private T GetResult(short token)
     /// <inheritdoc />
     void IValueTaskSource.GetResult(short token) => GetResult(token);
 
-    private ValueTaskSourceStatus GetStatus(short token)
-    {
-        var error = result.Error;
-        var snapshot = versionAndStatus.VolatileRead(); // barrier to avoid reordering of result read
-
-        if (token != snapshot.Version)
-            throw new InvalidOperationException(ExceptionMessages.InvalidSourceToken);
-
-        return !snapshot.IsCompleted ? ValueTaskSourceStatus.Pending : error switch
-        {
-            null => ValueTaskSourceStatus.Succeeded,
-            OperationCanceledException => ValueTaskSourceStatus.Canceled,
-            _ => ValueTaskSourceStatus.Faulted,
-        };
-    }
-
-    /// <inheritdoc />
-    ValueTaskSourceStatus IValueTaskSource<T>.GetStatus(short token) => GetStatus(token);
-
-    /// <inheritdoc />
-    ValueTaskSourceStatus IValueTaskSource.GetStatus(short token) => GetStatus(token);
-
-    /// <inheritdoc />
-    void IValueTaskSource<T>.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
-        => OnCompleted(continuation, state, token, flags);
-
-    /// <inheritdoc />
-    void IValueTaskSource.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
-        => OnCompleted(continuation, state, token, flags);
+    /// <inheritdoc cref="IValueTaskSource.GetStatus"/>
+    [EditorBrowsable(EditorBrowsableState.Never)]
+    public ValueTaskSourceStatus GetStatus(short token)
+        => GetStatus(token, result.Error);
 
     /// <summary>
     /// Creates a linked <see cref="TaskCompletionSource{TResult}"/> that can be used cooperatively to

src/DotNext.Threading/Threading/Tasks/ValueTaskCompletionSource.cs

@@ -136,31 +136,31 @@ public bool TrySetException(object? completionData, short completionToken, Excep
         => SetResult<ValueSupplier<Exception>>(completionData, completionToken, e);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <returns><see langword="true"/> if the result is completed successfully; <see langword="false"/> if the task has been canceled or timed out.</returns>
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public bool TrySetResult()
         => TrySetResult(null);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionData">The data to be saved in <see cref="ManualResetCompletionSource.CompletionData"/> property that can be accessed from within <see cref="ManualResetCompletionSource.AfterConsumed"/> method.</param>
     /// <returns><see langword="true"/> if the result is completed successfully; <see langword="false"/> if the task has been canceled or timed out.</returns>
     public bool TrySetResult(object? completionData)
         => SetResult(completionData, completionToken: null, ISupplier<Exception>.NullOrDefault);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionToken">The completion token previously obtained from <see cref="CreateTask(TimeSpan, CancellationToken)"/> method.</param>
     /// <returns><see langword="true"/> if the result is completed successfully; <see langword="false"/> if the task has been canceled or timed out.</returns>
     public bool TrySetResult(short completionToken)
         => TrySetResult(null, completionToken);
 
     /// <summary>
-    /// Attempts to complete the task sucessfully.
+    /// Attempts to complete the task successfully.
     /// </summary>
     /// <param name="completionData">The data to be saved in <see cref="ManualResetCompletionSource.CompletionData"/> property that can be accessed from within <see cref="ManualResetCompletionSource.AfterConsumed"/> method.</param>
     /// <param name="completionToken">The completion token previously obtained from <see cref="CreateTask(TimeSpan, CancellationToken)"/> method.</param>
@@ -176,7 +176,7 @@ public bool TrySetResult(object? completionData, short completionToken)
     /// </remarks>
     /// <param name="timeout">The timeout associated with the task.</param>
     /// <param name="token">The cancellation token that can be used to cancel the task.</param>
-    /// <returns>A fresh incompleted task.</returns>
+    /// <returns>A fresh uncompleted task.</returns>
     /// <exception cref="ArgumentOutOfRangeException"><paramref name="timeout"/> is less than zero but not equals to <see cref="System.Threading.Timeout.InfiniteTimeSpan"/>.</exception>
     /// <exception cref="InvalidOperationException">The source is in invalid state.</exception>
     public ValueTask CreateTask(TimeSpan timeout, CancellationToken token)
@@ -200,24 +200,7 @@ void IValueTaskSource.GetResult(short token)
 
     /// <inheritdoc />
     ValueTaskSourceStatus IValueTaskSource.GetStatus(short token)
-    {
-        var resultCopy = result;
-        var snapshot = versionAndStatus.VolatileRead(); // barrier to avoid reordering of result read
-
-        if (token != snapshot.Version)
-            throw new InvalidOperationException(ExceptionMessages.InvalidSourceToken);
-
-        return !snapshot.IsCompleted ? ValueTaskSourceStatus.Pending : resultCopy switch
-        {
-            null => ValueTaskSourceStatus.Succeeded,
-            { SourceException: OperationCanceledException } => ValueTaskSourceStatus.Canceled,
-            _ => ValueTaskSourceStatus.Faulted,
-        };
-    }
-
-    /// <inheritdoc />
-    void IValueTaskSource.OnCompleted(Action<object?> continuation, object? state, short token, ValueTaskSourceOnCompletedFlags flags)
-        => OnCompleted(continuation, state, token, flags);
+        => GetStatus(token, result?.SourceException);
 
     /// <summary>
     /// Creates a linked <see cref="TaskCompletionSource"/> that can be used cooperatively to