Initial API Review (1) (#1185)

src/Polly.Core/CircuitBreaker/BaseCircuitBreakerStrategyOptions.TResult.cs

@@ -89,15 +89,15 @@ public abstract class BaseCircuitBreakerStrategyOptions<TResult> : ResilienceStr
     /// Gets or sets the manual control for the circuit breaker.
     /// </summary>
     /// <remarks>
-    /// Defaults to <c>null</c>.
+    /// Defaults to <see langword="null"/>.
     /// </remarks>
     public CircuitBreakerManualControl? ManualControl { get; set; }
 
     /// <summary>
     /// Gets or sets the state provider for the circuit breaker.
     /// </summary>
     /// <remarks>
-    /// Defaults to <c>null</c>.
+    /// Defaults to <see langword="null"/>.
     /// </remarks>
     public CircuitBreakerStateProvider? StateProvider { get; set; }
 

src/Polly.Core/CircuitBreaker/BaseCircuitBreakerStrategyOptions.cs

@@ -88,15 +88,15 @@ public abstract class BaseCircuitBreakerStrategyOptions : ResilienceStrategyOpti
     /// Gets or sets the manual control for the circuit breaker.
     /// </summary>
     /// <remarks>
-    /// Defaults to <c>null</c>.
+    /// Defaults to <see langword="null"/>.
     /// </remarks>
     public CircuitBreakerManualControl? ManualControl { get; set; }
 
     /// <summary>
     /// Gets or sets the state provider for the circuit breaker.
     /// </summary>
     /// <remarks>
-    /// Defaults to <c>null</c>.
+    /// Defaults to <see langword="null"/>.
     /// </remarks>
     public CircuitBreakerStateProvider? StateProvider { get; set; }
 

src/Polly.Core/CircuitBreaker/CircuitBreakerManualControl.cs

@@ -57,7 +57,7 @@ public Task IsolateAsync(ResilienceContext context)
     /// <param name="cancellationToken">The cancellation token.</param>
     /// <returns>The instance of <see cref="Task"/> that represents the asynchronous execution.</returns>
     /// <exception cref="InvalidOperationException">Thrown if manual control is not initialized.</exception>
-    public async Task IsolateAsync(CancellationToken cancellationToken)
+    public async Task IsolateAsync(CancellationToken cancellationToken = default)
     {
         var context = ResilienceContext.Get();
         context.CancellationToken = cancellationToken;
@@ -97,7 +97,7 @@ public Task CloseAsync(ResilienceContext context)
     /// <param name="cancellationToken">The cancellation token.</param>
     /// <returns>The instance of <see cref="Task"/> that represents the asynchronous execution.</returns>
     /// <exception cref="InvalidOperationException">Thrown if manual control is not initialized.</exception>
-    public async Task CloseAsync(CancellationToken cancellationToken)
+    public async Task CloseAsync(CancellationToken cancellationToken = default)
     {
         var context = ResilienceContext.Get();
         context.CancellationToken = cancellationToken;

src/Polly.Core/Fallback/FallbackHandler.cs

@@ -13,7 +13,7 @@ public sealed partial class FallbackHandler
     /// <summary>
     /// Gets a value indicating whether the fallback handler is empty.
     /// </summary>
-    public bool IsEmpty => _predicates.IsEmpty;
+    internal bool IsEmpty => _predicates.IsEmpty;
 
     /// <summary>
     /// Configures a fallback handler for a specific result type.

src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs

@@ -27,7 +27,7 @@ public class FallbackStrategyOptions<TResult> : ResilienceStrategyOptions
     /// Gets or sets the fallback action to be executed if the <see cref="ShouldHandle"/> predicate evaluates as true.
     /// </summary>
     /// <remarks>
-    /// This property is required. Defaults to <c>null</c>.
+    /// This property is required. Defaults to <see langword="null"/>.
     /// </remarks>
     [Required]
     public FallbackAction<TResult>? FallbackAction { get; set; }

src/Polly.Core/Hedging/HedgingActionGenerator.TResult.cs

@@ -7,7 +7,7 @@ namespace Polly.Hedging;
 /// <param name="arguments">The arguments passed to the generator.</param>
 /// <returns>A <see cref="Task{TResult}"/> that represents an asynchronous operation.</returns>
 /// <remarks>
-/// The generator can return a <c>null</c> function. In that case the hedging is not executed for that attempt.
+/// The generator can return a <see langword="null"/> function. In that case the hedging is not executed for that attempt.
 /// Make sure that the returned action represents a real asynchronous work when invoked.
 /// </remarks>
 public delegate Func<Task<TResult>>? HedgingActionGenerator<TResult>(HedgingActionGeneratorArguments<TResult> arguments);

src/Polly.Core/Hedging/HedgingActionGenerator.cs

@@ -6,7 +6,7 @@ namespace Polly.Hedging;
 /// <param name="arguments">The arguments passed to the generator.</param>
 /// <returns>A <see cref="Task"/> that represents an asynchronous operation.</returns>
 /// <remarks>
-/// The generator can return a <c>null</c> function. In that case the hedging is not executed for that attempt.
+/// The generator can return a <see langword="null"/> function. In that case the hedging is not executed for that attempt.
 /// Make sure that the returned action represents a real asynchronous work when invoked.
 /// </remarks>
 public delegate Func<Task>? HedgingActionGenerator(HedgingActionGeneratorArguments arguments);

src/Polly.Core/Hedging/HedgingHandler.TResult.cs

@@ -23,7 +23,7 @@ public sealed class HedgingHandler<TResult>
     /// Gets or sets the hedging action generator that creates hedged actions.
     /// </summary>
     /// <remarks>
-    /// This property is required. Defaults to <c>null</c>.
+    /// This property is required. Defaults to <see langword="null"/>.
     /// </remarks>
     [Required]
     public HedgingActionGenerator<TResult>? HedgingActionGenerator { get; set; } = null;

src/Polly.Core/Hedging/HedgingHandler.cs

@@ -13,7 +13,7 @@ public sealed partial class HedgingHandler
     /// <summary>
     /// Gets a value indicating whether the hedging handler is empty.
     /// </summary>
-    public bool IsEmpty => _actions.Count == 0;
+    internal bool IsEmpty => _actions.Count == 0;
 
     /// <summary>
     /// Configures a hedging handler for a specific result type.

src/Polly.Core/Hedging/VoidHedgingHandler.cs

@@ -22,7 +22,7 @@ public sealed class VoidHedgingHandler
     /// Gets or sets the hedging action generator that creates hedged actions.
     /// </summary>
     /// <remarks>
-    /// This property is required. Defaults to <c>null</c>.
+    /// This property is required. Defaults to <see langword="null"/>.
     /// </remarks>
     [Required]
     public HedgingActionGenerator? HedgingActionGenerator { get; set; } = null;

src/Polly.Core/ResilienceStrategy.Async.Task.cs

@@ -69,7 +69,7 @@ static async (context, state) =>
     public async Task ExecuteAsync<TState>(
         Func<TState, CancellationToken, Task> callback,
         TState state,
-        CancellationToken cancellationToken)
+        CancellationToken cancellationToken = default)
     {
         Guard.NotNull(callback);
 

src/Polly.Core/ResilienceStrategy.Async.TaskT.cs

@@ -69,7 +69,7 @@ static async (context, state) =>
     public async Task<TResult> ExecuteAsync<TResult, TState>(
         Func<TState, CancellationToken, Task<TResult>> callback,
         TState state,
-        CancellationToken cancellationToken)
+        CancellationToken cancellationToken = default)
     {
         Guard.NotNull(callback);
 

src/Polly.Core/ResilienceStrategy.SyncT.cs

@@ -143,7 +143,7 @@ public TResult Execute<TResult, TState>(Func<TState, TResult> callback, TState s
     public TResult Execute<TResult, TState>(
         Func<TState, CancellationToken, TResult> callback,
         TState state,
-        CancellationToken cancellationToken)
+        CancellationToken cancellationToken = default)
     {
         Guard.NotNull(callback);
 

src/Polly.Core/Strategy/NoOutcomeEvent.cs

@@ -15,7 +15,7 @@ public sealed class NoOutcomeEvent<TArgs>
     /// <summary>
     /// Gets a value indicating whether the event is empty.
     /// </summary>
-    public bool IsEmpty => _callbacks.Count == 0;
+    internal bool IsEmpty => _callbacks.Count == 0;
 
     /// <summary>
     /// Adds an asynchronous event callback.

src/Polly.Core/Strategy/NoOutcomeGenerator.cs

@@ -13,7 +13,7 @@ public sealed class NoOutcomeGenerator<TArgs, TValue>
     /// <summary>
     /// Gets a value indicating whether the generator is empty.
     /// </summary>
-    public bool IsEmpty => _generator is null;
+    internal bool IsEmpty => _generator is null;
 
     /// <summary>
     /// Adds a result generator.

src/Polly.Core/Strategy/Outcome.TResult.cs

@@ -36,7 +36,7 @@ public Outcome(TResult result)
     /// Gets a value indicating whether the operation produced a result.
     /// </summary>
     /// <remarks>
-    /// If the operation returned a void result the value will be <c>true</c>.
+    /// If the operation returned a void result the value will be <see langword="true"/>.
     /// You can use <see cref="IsVoidResult"/> to determine if the result is a void result.
     /// </remarks>
     public bool HasResult => Exception == null;

src/Polly.Core/Strategy/Outcome.cs

@@ -55,7 +55,7 @@ public Outcome(Type resultType, object? result)
     /// Gets a value indicating whether the operation produced a result.
     /// </summary>
     /// <remarks>
-    /// If the operation returned a void result the value will be <c>true</c>.
+    /// If the operation returned a void result the value will be <see langword="true"/>.
     /// You can use <see cref="IsVoidResult"/> to determine if the result is a void result.
     /// </remarks>
     public bool HasResult => Exception == null;

src/Polly.Core/Strategy/OutcomeEvent.TResult.cs

@@ -16,7 +16,7 @@ public sealed class OutcomeEvent<TArgs, TResult>
     /// <summary>
     /// Gets a value indicating whether the event is empty.
     /// </summary>
-    public bool IsEmpty => _callbacks.Count == 0;
+    internal bool IsEmpty => _callbacks.Count == 0;
 
     /// <summary>
     /// Registers a callback for the specified result type.
@@ -83,7 +83,7 @@ public OutcomeEvent<TArgs, TResult> Register(Func<Outcome<TResult>, TArgs, Value
     /// <summary>
     /// Creates a handler that invokes the registered event callbacks.
     /// </summary>
-    /// <returns>Handler instance or <c>null</c> if no callbacks are registered.</returns>
+    /// <returns>Handler instance or <see langword="null"/> if no callbacks are registered.</returns>
     public Func<Outcome<TResult>, TArgs, ValueTask>? CreateHandler()
     {
         return _callbacks.Count switch

src/Polly.Core/Strategy/OutcomeEvent.cs

@@ -15,7 +15,7 @@ public sealed partial class OutcomeEvent<TArgs>
     /// <summary>
     /// Gets a value indicating whether the event is empty.
     /// </summary>
-    public bool IsEmpty => _callbacks.Count == 0;
+    internal bool IsEmpty => _callbacks.Count == 0;
 
     /// <summary>
     /// Registers a callback for the specified result type.
@@ -157,7 +157,7 @@ public OutcomeEvent<TArgs> SetCallbacks<TResult>(OutcomeEvent<TArgs, TResult> ca
     /// <summary>
     /// Creates an event handler.
     /// </summary>
-    /// <returns>Handler instance or <c>null</c> if no callbacks are registered.</returns>
+    /// <returns>Handler instance or <see langword="null"/> if no callbacks are registered.</returns>
     public Handler? CreateHandler()
     {
         var pairs = _callbacks

src/Polly.Core/Strategy/OutcomeGenerator.TResult.cs

@@ -20,7 +20,7 @@ public sealed class OutcomeGenerator<TArgs, TValue, TResult>
     /// <summary>
     /// Gets a value indicating whether the generator is empty.
     /// </summary>
-    public bool IsEmpty => _generator is null;
+    internal bool IsEmpty => _generator is null;
 
     /// <summary>
     /// Sets a result generator for a specific result type.

src/Polly.Core/Strategy/OutcomeGenerator.cs

@@ -17,7 +17,7 @@ public sealed partial class OutcomeGenerator<TArgs, TValue>
     /// <summary>
     /// Gets a value indicating whether the generator is empty.
     /// </summary>
-    public bool IsEmpty => _generators.Count == 0;
+    internal bool IsEmpty => _generators.Count == 0;
 
     /// <summary>
     /// Sets a result generator for a specific result type.

src/Polly.Core/Strategy/OutcomePredicate.TResult.cs

@@ -18,7 +18,7 @@ public sealed class OutcomePredicate<TArgs, TResult>
     /// <summary>
     /// Gets a value indicating whether the predicate is empty.
     /// </summary>
-    public bool IsEmpty => _predicates.Count == 0;
+    internal bool IsEmpty => _predicates.Count == 0;
 
     /// <summary>
     /// Adds an exception predicate for the specified exception type.

src/Polly.Core/Strategy/OutcomePredicate.cs

@@ -16,7 +16,7 @@ public sealed partial class OutcomePredicate<TArgs>
     /// <summary>
     /// Gets a value indicating whether the predicate is empty.
     /// </summary>
-    public bool IsEmpty => _predicates.Count == 0;
+    internal bool IsEmpty => _predicates.Count == 0;
 
     /// <summary>
     /// Adds an exception predicate for the specified exception type.

src/Polly.Core/Strategy/VoidOutcomeEvent.cs

@@ -15,7 +15,7 @@ public sealed class VoidOutcomeEvent<TArgs>
     /// <summary>
     /// Gets a value indicating whether the event is empty.
     /// </summary>
-    public bool IsEmpty => _callbacks.Count == 0;
+    internal bool IsEmpty => _callbacks.Count == 0;
 
     /// <summary>
     /// Registers a callback for void-based results.
@@ -82,7 +82,7 @@ public VoidOutcomeEvent<TArgs> Register(Func<Outcome, TArgs, ValueTask> callback
     /// <summary>
     /// Creates a handler that invokes the registered event callbacks.
     /// </summary>
-    /// <returns>Handler instance or <c>null</c> if no callbacks are registered.</returns>
+    /// <returns>Handler instance or <see langword="null"/> if no callbacks are registered.</returns>
     public Func<Outcome, TArgs, ValueTask>? CreateHandler()
     {
         return _callbacks.Count switch

src/Polly.Core/Strategy/VoidOutcomeGenerator.cs

@@ -16,7 +16,7 @@ public sealed class VoidOutcomeGenerator<TArgs, TValue>
     /// <summary>
     /// Gets a value indicating whether the generator is empty.
     /// </summary>
-    public bool IsEmpty => _generator is null;
+    internal bool IsEmpty => _generator is null;
 
     /// <summary>
     /// Sets a result generator.

src/Polly.Core/Strategy/VoidOutcomePredicate.cs

@@ -17,7 +17,7 @@ public sealed class VoidOutcomePredicate<TArgs>
     /// <summary>
     /// Gets a value indicating whether the predicate is empty.
     /// </summary>
-    public bool IsEmpty => _predicates.Count == 0;
+    internal bool IsEmpty => _predicates.Count == 0;
 
     /// <summary>
     /// Adds an exception predicate for void-based results.