BenchmarkCommandBuilder Class

Summary

Builder for BenchmarkCommand.
graph BT Type-->Base0["BaseOutputBuilder<BenchmarkCommandBuilder, IBenchmarkOutput>"] Base0-->Base1["Object"] Type["BenchmarkCommandBuilder"] class Type type-node

Syntax

public sealed class BenchmarkCommandBuilder : 
    BaseOutputBuilder<BenchmarkCommandBuilder, IBenchmarkOutput>

Examples

Task("DoBenchmark")
    .Does(() =>
{
    SevenZip(m => m
        .InBenchmarkMode()
        .WithMethod("*")
        .WithNumberOfIterations(2)
        .WithCommandOutput(o =>
        {
            Information("7Zip version is:" + o.Information);
            Information("Benchmark results:");
            Information(o.Benchmark);
        }));
});

Attributes

Type Description
NullableContextAttribute
NullableAttribute

Properties

Name Value Summary
OutputCommand BaseOutputCommand<IBenchmarkOutput>
Gets the output command.

Methods

Name Value Summary
WithDictionarySize(int) BenchmarkCommandBuilder
Sets the size of the dictionary.
WithMethod(string) BenchmarkCommandBuilder
Sets the method.
WithNumberOfIterations(int) BenchmarkCommandBuilder
Sets the number of iterations.
WithNumberOfThreads(int) BenchmarkCommandBuilder
Sets the number of threads.

Extension Methods

Name Value Summary
Dump<BenchmarkCommandBuilder>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BenchmarkCommandBuilder>(BenchmarkCommandBuilder[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BenchmarkCommandBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<BenchmarkCommandBuilder>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<BenchmarkCommandBuilder>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<BenchmarkCommandBuilder>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin

See Also