RunAsync Method

Definition

Namespace

Codebelt.Extensions.BenchmarkDotNet.Console

Assemblies

Codebelt.Extensions.BenchmarkDotNet.Console.dll

Source

src/Codebelt.Extensions.BenchmarkDotNet.Console/BenchmarkProgram.cs

RunAsync(string[], Action<BenchmarkWorkspaceOptions>)

Runs benchmarks asynchronously using the default BenchmarkWorkspace implementation.

public static Task RunAsync(string[] args, Action<BenchmarkWorkspaceOptions> setup = null)

Parameters

args string[]

The command-line arguments passed to the application.

setup Action<BenchmarkWorkspaceOptions>

The BenchmarkWorkspaceOptions which may be configured.

Returns

Task

A task that represents the asynchronous benchmark host operation.

Remarks

This method configures the host builder with the necessary services, builds the host, and runs it asynchronously to execute benchmarks.

RunAsync(string[], Action<IServiceCollection>, Action<BenchmarkWorkspaceOptions>)

Runs benchmarks asynchronously using the default BenchmarkWorkspace implementation.

public static Task RunAsync(string[] args, Action<IServiceCollection> serviceConfigurator = null, Action<BenchmarkWorkspaceOptions> setup = null)

Parameters

args string[]

The command-line arguments passed to the application.

serviceConfigurator Action<IServiceCollection>

The delegate that will be invoked to configure additional services in the IServiceCollection.

setup Action<BenchmarkWorkspaceOptions>

The BenchmarkWorkspaceOptions which may be configured.

Returns

Task

A task that represents the asynchronous benchmark host operation.

Remarks

This method configures the host builder with the necessary services, builds the host, and runs it asynchronously to execute benchmarks.

RunAsync<TWorkspace>(string[], Action<BenchmarkWorkspaceOptions>)

Runs benchmarks asynchronously using a custom implementation of IBenchmarkWorkspace.

public static Task RunAsync<TWorkspace>(string[] args, Action<BenchmarkWorkspaceOptions> setup = null) where TWorkspace : class, IBenchmarkWorkspace

Parameters

args string[]

The command-line arguments passed to the application.

setup Action<BenchmarkWorkspaceOptions>

The BenchmarkWorkspaceOptions which may be configured.

Returns

Task

A task that represents the asynchronous benchmark host operation.

Type Parameters

TWorkspace

The type of the workspace that implements IBenchmarkWorkspace.

Remarks

This method configures the host builder with the necessary services, builds the host, and runs it asynchronously to execute benchmarks.

RunAsync<TWorkspace>(string[], Action<IServiceCollection>, Action<BenchmarkWorkspaceOptions>)

Runs benchmarks asynchronously using a custom implementation of IBenchmarkWorkspace.

public static Task RunAsync<TWorkspace>(string[] args, Action<IServiceCollection> serviceConfigurator = null, Action<BenchmarkWorkspaceOptions> setup = null) where TWorkspace : class, IBenchmarkWorkspace

Parameters

args string[]

The command-line arguments passed to the application.

serviceConfigurator Action<IServiceCollection>

The delegate that will be invoked to configure additional services in the IServiceCollection.

setup Action<BenchmarkWorkspaceOptions>

The BenchmarkWorkspaceOptions which may be configured.

Returns

Task

A task that represents the asynchronous benchmark host operation.

Type Parameters

TWorkspace

The type of the workspace that implements IBenchmarkWorkspace.

Remarks

This method configures the host builder with the necessary services, builds the host, and runs it asynchronously to execute benchmarks.

RunAsync(IServiceProvider, CancellationToken)

Runs the actual benchmarks as envisioned by BenchmarkDotNet.

public override Task RunAsync(IServiceProvider serviceProvider, CancellationToken cancellationToken)

Parameters

serviceProvider IServiceProvider

The service provider.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A completed task when benchmark execution has finished.

Remarks

When arguments are provided, they are forwarded to BenchmarkDotNet.Running.BenchmarkSwitcher for selective execution. After execution completes, artifact post-processing is performed.