Class SummaryStyle

Namespace

BenchmarkDotNet.Reports

Assembly

BenchmarkDotNet.dll

public class SummaryStyle : IEquatable<SummaryStyle>

Inheritance

object

SummaryStyle

Implements

IEquatable<SummaryStyle>

Constructors

SummaryStyle(CultureInfo?, bool, SizeUnit?, TimeUnit?, bool, bool, int, RatioStyle, TextJustification, TextJustification)

public SummaryStyle(CultureInfo? cultureInfo, bool printUnitsInHeader, SizeUnit? sizeUnit, TimeUnit? timeUnit, bool printUnitsInContent = true, bool printZeroValuesInContent = false, int maxParameterColumnWidth = 20, RatioStyle ratioStyle = RatioStyle.Value, SummaryTable.SummaryTableColumn.TextJustification textColumnJustification = TextJustification.Left, SummaryTable.SummaryTableColumn.TextJustification numericColumnJustification = TextJustification.Right)

Parameters

cultureInfo CultureInfo

printUnitsInHeader bool

sizeUnit SizeUnit

timeUnit TimeUnit

printUnitsInContent bool

printZeroValuesInContent bool

maxParameterColumnWidth int

ratioStyle RatioStyle

textColumnJustification SummaryTable.SummaryTableColumn.TextJustification

numericColumnJustification SummaryTable.SummaryTableColumn.TextJustification

Fields

Default

public static readonly SummaryStyle Default

Field Value

SummaryStyle

Properties

CultureInfo

public CultureInfo CultureInfo { get; }

Property Value

CultureInfo

MaxParameterColumnWidth

public int MaxParameterColumnWidth { get; }

Property Value

int

NumericColumnJustification

public SummaryTable.SummaryTableColumn.TextJustification NumericColumnJustification { get; }

Property Value

SummaryTable.SummaryTableColumn.TextJustification

PrintUnitsInContent

public bool PrintUnitsInContent { get; }

Property Value

bool

PrintUnitsInHeader

public bool PrintUnitsInHeader { get; }

Property Value

bool

PrintZeroValuesInContent

public bool PrintZeroValuesInContent { get; }

Property Value

bool

RatioStyle

public RatioStyle RatioStyle { get; }

Property Value

RatioStyle

SizeUnit

public SizeUnit? SizeUnit { get; }

Property Value

SizeUnit

TextColumnJustification

public SummaryTable.SummaryTableColumn.TextJustification TextColumnJustification { get; }

Property Value

SummaryTable.SummaryTableColumn.TextJustification

TimeUnit

public TimeUnit? TimeUnit { get; }

Property Value

TimeUnit

Methods

Equals(SummaryStyle)

public bool Equals(SummaryStyle other)

Parameters

other SummaryStyle

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

WithCultureInfo(CultureInfo)

public SummaryStyle WithCultureInfo(CultureInfo cultureInfo)

Parameters

cultureInfo CultureInfo

Returns

SummaryStyle

WithMaxParameterColumnWidth(int)

public SummaryStyle WithMaxParameterColumnWidth(int maxParameterColumnWidth)

Parameters

maxParameterColumnWidth int

Returns

SummaryStyle

WithRatioStyle(RatioStyle)

public SummaryStyle WithRatioStyle(RatioStyle ratioStyle)

Parameters

ratioStyle RatioStyle

Returns

SummaryStyle

WithSizeUnit(SizeUnit)

public SummaryStyle WithSizeUnit(SizeUnit sizeUnit)

Parameters

sizeUnit SizeUnit

Returns

SummaryStyle

WithTimeUnit(TimeUnit)

public SummaryStyle WithTimeUnit(TimeUnit timeUnit)

Parameters

timeUnit TimeUnit

Returns

SummaryStyle

WithZeroMetricValuesInContent()

public SummaryStyle WithZeroMetricValuesInContent()

Returns

SummaryStyle

Operators

operator ==(SummaryStyle, SummaryStyle)

public static bool operator ==(SummaryStyle left, SummaryStyle right)

Parameters

left SummaryStyle

right SummaryStyle

Returns

bool

operator !=(SummaryStyle, SummaryStyle)

public static bool operator !=(SummaryStyle left, SummaryStyle right)

Parameters

left SummaryStyle

right SummaryStyle

Returns

bool