mirror of
https://github.com/spectreconsole/spectre.console.git
synced 2025-10-25 15:19:23 +00:00
Also raise CA2016 (forward the CancellationToken parameter to methods that take one) to warning Fixes #701
48 lines
1.9 KiB
C#
48 lines
1.9 KiB
C#
namespace Spectre.Console.Cli;
|
|
|
|
/// <summary>
|
|
/// Base class for an asynchronous command.
|
|
/// </summary>
|
|
/// <typeparam name="TSettings">The settings type.</typeparam>
|
|
public abstract class AsyncCommand<TSettings> : ICommand<TSettings>
|
|
where TSettings : CommandSettings
|
|
{
|
|
/// <summary>
|
|
/// Validates the specified settings and remaining arguments.
|
|
/// </summary>
|
|
/// <param name="context">The command context.</param>
|
|
/// <param name="settings">The settings.</param>
|
|
/// <returns>The validation result.</returns>
|
|
public virtual ValidationResult Validate(CommandContext context, TSettings settings)
|
|
{
|
|
return ValidationResult.Success();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Executes the command.
|
|
/// </summary>
|
|
/// <param name="context">The command context.</param>
|
|
/// <param name="settings">The settings.</param>
|
|
/// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to abort the command.</param>
|
|
/// <returns>An integer indicating whether or not the command executed successfully.</returns>
|
|
public abstract Task<int> ExecuteAsync(CommandContext context, TSettings settings, CancellationToken cancellationToken);
|
|
|
|
/// <inheritdoc/>
|
|
ValidationResult ICommand.Validate(CommandContext context, CommandSettings settings)
|
|
{
|
|
return Validate(context, (TSettings)settings);
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
Task<int> ICommand.ExecuteAsync(CommandContext context, CommandSettings settings, CancellationToken cancellationToken)
|
|
{
|
|
Debug.Assert(settings is TSettings, "Command settings is of unexpected type.");
|
|
return ExecuteAsync(context, (TSettings)settings, cancellationToken);
|
|
}
|
|
|
|
/// <inheritdoc/>
|
|
Task<int> ICommand<TSettings>.ExecuteAsync(CommandContext context, TSettings settings, CancellationToken cancellationToken)
|
|
{
|
|
return ExecuteAsync(context, settings, cancellationToken);
|
|
}
|
|
} |