Struct ProfilerResult

The result of a single benchmark run or iteration.

Implements
Inherited Members
Namespace: BionicCode.Utilities.Net
Assembly: BionicCode.Utilities.Net.Common.dll
Syntax
public readonly struct ProfilerResult : IEquatable<ProfilerResult>, IComparable<ProfilerResult>

Properties

| Improve this Doc View Source

ElapsedTime

The duration of the benchmark run.

Declaration
public readonly TimeSpan ElapsedTime { get; }
Property Value
Type Description
TimeSpan

The duration.
| Improve this Doc View Source

IsProfiledTaskCancelled

In case the benchmarked operation is an async method, IsProfiledTaskCancelled indiocates wwhether the asyncoperation was cancelled or not.

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

true in case the operation wwwas cancelled (and the ProfiledTask result is in a canlled state (Status returns Canceled).
| Improve this Doc View Source

Iteration

In case of a multi-run benchmark run (e.g. by calling LogTime(Action, Int32)), the property Iteration returns the run's actual number the ProfilerResult is associated with.

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

The number of the run the ProfilerResult is associated with. Otherwise -1.
| Improve this Doc View Source

ProfiledTask

The Task returned from the async operation that was benchmarked.

Declaration
public readonly Task ProfiledTask { get; }
Property Value
Type Description
Task

The Task result.

Methods

| Improve this Doc View Source

CompareTo(ProfilerResult)

Declaration
public readonly int CompareTo(ProfilerResult other)
Parameters
Type Name Description
ProfilerResult other
Returns
Type Description
Int32
| Improve this Doc View Source

Equals(ProfilerResult)

Declaration
public readonly bool Equals(ProfilerResult other)
Parameters
Type Name Description
ProfilerResult other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override readonly bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

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

Operators

| Improve this Doc View Source

Equality(ProfilerResult, ProfilerResult)

Declaration
public static bool operator ==(ProfilerResult left, ProfilerResult right)
Parameters
Type Name Description
ProfilerResult left
ProfilerResult right
Returns
Type Description
Boolean
| Improve this Doc View Source

GreaterThan(ProfilerResult, ProfilerResult)

Declaration
public static bool operator>(ProfilerResult left, ProfilerResult right)
Parameters
Type Name Description
ProfilerResult left
ProfilerResult right
Returns
Type Description
Boolean
| Improve this Doc View Source

GreaterThanOrEqual(ProfilerResult, ProfilerResult)

Declaration
public static bool operator >=(ProfilerResult left, ProfilerResult right)
Parameters
Type Name Description
ProfilerResult left
ProfilerResult right
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(ProfilerResult, ProfilerResult)

Declaration
public static bool operator !=(ProfilerResult left, ProfilerResult right)
Parameters
Type Name Description
ProfilerResult left
ProfilerResult right
Returns
Type Description
Boolean
| Improve this Doc View Source

LessThan(ProfilerResult, ProfilerResult)

Declaration
public static bool operator <(ProfilerResult left, ProfilerResult right)
Parameters
Type Name Description
ProfilerResult left
ProfilerResult right
Returns
Type Description
Boolean
| Improve this Doc View Source

LessThanOrEqual(ProfilerResult, ProfilerResult)

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

Implements

Extension Methods