Show / Hide Table of Contents

Class SummaryStyle

Inheritance
Object
SummaryStyle
Implements
IEquatable<SummaryStyle>
Namespace: BenchmarkDotNet.Reports
Assembly: BenchmarkDotNet.dll
Syntax
public class SummaryStyle : IEquatable<SummaryStyle>

Constructors

SummaryStyle(CultureInfo, Boolean, SizeUnit, TimeUnit, Boolean, Boolean, Int32, RatioStyle)

Declaration
public SummaryStyle(CultureInfo cultureInfo, bool printUnitsInHeader, SizeUnit sizeUnit, TimeUnit timeUnit, bool printUnitsInContent = true, bool printZeroValuesInContent = false, int maxParameterColumnWidth = 20, RatioStyle ratioStyle = RatioStyle.Value)
Parameters
Type Name Description
CultureInfo cultureInfo
Boolean printUnitsInHeader
SizeUnit sizeUnit
TimeUnit timeUnit
Boolean printUnitsInContent
Boolean printZeroValuesInContent
Int32 maxParameterColumnWidth
RatioStyle ratioStyle

Fields

Default

Declaration
public static readonly SummaryStyle Default
Field Value
Type Description
SummaryStyle

Properties

CultureInfo

Declaration
public CultureInfo CultureInfo { get; }
Property Value
Type Description
CultureInfo

MaxParameterColumnWidth

Declaration
public int MaxParameterColumnWidth { get; }
Property Value
Type Description
Int32

PrintUnitsInContent

Declaration
public bool PrintUnitsInContent { get; }
Property Value
Type Description
Boolean

PrintUnitsInHeader

Declaration
public bool PrintUnitsInHeader { get; }
Property Value
Type Description
Boolean

PrintZeroValuesInContent

Declaration
public bool PrintZeroValuesInContent { get; }
Property Value
Type Description
Boolean

RatioStyle

Declaration
public RatioStyle RatioStyle { get; }
Property Value
Type Description
RatioStyle

SizeUnit

Declaration
public SizeUnit SizeUnit { get; }
Property Value
Type Description
SizeUnit

TimeUnit

Declaration
public TimeUnit TimeUnit { get; }
Property Value
Type Description
TimeUnit

Methods

Equals(SummaryStyle)

Declaration
public bool Equals(SummaryStyle other)
Parameters
Type Name Description
SummaryStyle other
Returns
Type Description
Boolean

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
Object.Equals(Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
Object.GetHashCode()

WithCultureInfo(CultureInfo)

Declaration
public SummaryStyle WithCultureInfo(CultureInfo cultureInfo)
Parameters
Type Name Description
CultureInfo cultureInfo
Returns
Type Description
SummaryStyle

WithMaxParameterColumnWidth(Int32)

Declaration
public SummaryStyle WithMaxParameterColumnWidth(int maxParameterColumnWidth)
Parameters
Type Name Description
Int32 maxParameterColumnWidth
Returns
Type Description
SummaryStyle

WithRatioStyle(RatioStyle)

Declaration
public SummaryStyle WithRatioStyle(RatioStyle ratioStyle)
Parameters
Type Name Description
RatioStyle ratioStyle
Returns
Type Description
SummaryStyle

WithSizeUnit(SizeUnit)

Declaration
public SummaryStyle WithSizeUnit(SizeUnit sizeUnit)
Parameters
Type Name Description
SizeUnit sizeUnit
Returns
Type Description
SummaryStyle

WithTimeUnit(TimeUnit)

Declaration
public SummaryStyle WithTimeUnit(TimeUnit timeUnit)
Parameters
Type Name Description
TimeUnit timeUnit
Returns
Type Description
SummaryStyle

WithZeroMetricValuesInContent()

Declaration
public SummaryStyle WithZeroMetricValuesInContent()
Returns
Type Description
SummaryStyle

Operators

Equality(SummaryStyle, SummaryStyle)

Declaration
public static bool operator ==(SummaryStyle left, SummaryStyle right)
Parameters
Type Name Description
SummaryStyle left
SummaryStyle right
Returns
Type Description
Boolean

Inequality(SummaryStyle, SummaryStyle)

Declaration
public static bool operator !=(SummaryStyle left, SummaryStyle right)
Parameters
Type Name Description
SummaryStyle left
SummaryStyle right
Returns
Type Description
Boolean

Implements

System.IEquatable<T>
In This Article
Back to top Copyright © 2013–2021 .NET Foundation and contributors