ProgressManager.Properties.CompletedByteCount

defaultValue

static get defaultValue(): number

static var defaultValue: UInt64 { get }

The default value to return when property is not set to a specific value. This value is used when a progress manager doesn't have an explicit value set for this property type. - Returns: The default value for this property type.

finalSummary

static finalSummary(parentSummary: number, selfSummary: number): number

static func finalSummary(_ parentSummary: UInt64, _ selfSummary: UInt64) -> UInt64

Determines how to handle summary data when a progress manager is deinitialized. This method is used when a progress manager in the hierarchy is being deinitialized and its accumulated summary needs to be processed in relation to its parent's summary. The behavior can vary depending on the property type: - For additive properties (like file counts, byte counts): The self summary is typically added to the parent summary to preserve the accumulated progress. - For max-based properties (like estimated time remaining): The parent summary is typically preserved as it represents an existing estimate. - For collection-based properties (like file URLs): The self summary may be discarded to avoid accumulating stale references. - Parameters: - parentSummary: The current summary value of the parent progress manager. - selfSummary: The final summary value from the progress manager being deinitialized. - Returns: The updated summary that replaces the parent's current summary.

defaultSummary

static get defaultSummary(): number

static var defaultSummary: UInt64 { get }

The default summary value for this property type. This value is used as the initial summary when no property values have been aggregated yet. - Returns: The default summary value for this property type.

key

static get key(): string

static var key: String { get }

A unique identifier for this property type. The key should use reverse DNS style notation to ensure uniqueness across different frameworks and applications. - Returns: A unique string identifier for this property type.

merge

static merge(summary1: number, summary2: number): number

static func merge(_ summary1: UInt64, _ summary2: UInt64) -> UInt64

Merges two summary values into a single combined summary. This method is called to combine summary values from different branches of the progress manager hierarchy into a unified summary. - Parameters: - summary1: The first summary to merge. - summary2: The second summary to merge. - Returns: A new summary that represents the combination of both input summaries.

reduce

static reduce(summary: number, value: number): { $ret: null; $out: { "summary": number } }

static func reduce(into summary: inout UInt64, value: UInt64)

Reduces a property value into an accumulating summary. This method is called to incorporate individual property values into a summary that represents the aggregated state across multiple progress managers. - Parameters: - summary: The accumulating summary value to modify. - value: The individual property value to incorporate into the summary.

Omit the output parameters from the call. The result contains $ret and $out, with summary inside $out.