Struct ProgressReport

Namespace

ReFuel.IO

Assembly

ReFuel.Common.dll

An object that encapsulates a progress report.

public record struct ProgressReport : IEquatable<ProgressReport>

Implements

IEquatable<ProgressReport>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ProgressReport(float)

An object that encapsulates a progress report.

public ProgressReport(float Progress)

Parameters

Progress float

The reported progress value. -1 for marquee, otherwise in the range of [0.0,1.0].

Properties

CurrentSegment

The current segent, if TotalSegments > 1

public int CurrentSegment { readonly get; init; }

Property Value

int

Extras

An extra data field for you to use.

public object? Extras { readonly get; init; }

Property Value

object

Message

A progress message, if any.

public string? Message { readonly get; init; }

Property Value

string

Progress

The reported progress value. -1 for marquee, otherwise in the range of [0.0,1.0].

public float Progress { readonly get; set; }

Property Value

float

SegmentName

Name of the segment, if any.

public string? SegmentName { readonly get; init; }

Property Value

string

TimeStamp

A time stamp for this progress report.

public DateTime TimeStamp { readonly get; init; }

Property Value

DateTime

TotalSegments

Total number of segments for this process.

public int TotalSegments { readonly get; init; }

Property Value

int

Methods

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.