ProfileRegionResult class

A summary of profiling data for a marked region.

The same shape is also used for the synthetic whole-session profile stored on ProfileRunResult.overallProfile. CPU summaries, capture metadata, artifact paths, and optional memory summaries are grouped here so CLI and MCP consumers can reason over one uniform result type.

Constructors

ProfileRegionResult({required String regionId, required String name, required Map<String, String> attributes, required String isolateId, required int startTimestampMicros, required int endTimestampMicros, required int durationMicros, required int sampleCount, required int samplePeriodMicros, required List<ProfileFrameSummary> topSelfFrames, required List<ProfileFrameSummary> topTotalFrames, required String summaryPath, ProfileMemoryResult? memory, String? parentRegionId, Map<String, Object?> extra = const {}, List<String>? isolateIds, List<ProfileCaptureKind> captureKinds = defaultProfileCaptureKinds, ProfileIsolateScope isolateScope = ProfileIsolateScope.current, String? rawProfilePath, String? error})

Creates a region profiling result.

ProfileRegionResult.fromJson(Map<String, Object?> json)

Deserializes a region profiling result from JSON.

factory

Properties

attributes → Map<String, String>

Extra attributes attached to the region.

final

captureKinds → List<ProfileCaptureKind>

The capture kinds included in the region result.

final

durationMicros → int

The total duration of the region.

final

endTimestampMicros → int

The region stop timestamp from Timeline.now.

final

error → String?

The capture error, when the region could not be profiled successfully.

final

extra → Map<String, Object?>

Extra tool-specific metadata attached at region start.

final

hashCode → int

The hash code for this object.

no setter, inherited

isolateId → String

The isolate ID that emitted the region markers.

final

isolateIds → List<String>

The isolate IDs included in the capture.

final

isolateScope → ProfileIsolateScope

The isolate scope used for the capture.

final

memory → ProfileMemoryResult?

Memory and allocation summary data, when captured.

final

name → String

The user-provided region name.

final

parentRegionId → String?

The parent region id when this region was started inside another region.

final

rawProfilePath → String?

The path to the raw CPU profile artifact when capture succeeded.

final

regionId → String

The region identifier generated by the helper package.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sampleCount → int

The number of CPU samples captured for the region.

final

samplePeriodMicros → int

The profiler sample period reported by the VM.

final

startTimestampMicros → int

The region start timestamp from Timeline.now.

final

succeeded → bool

Whether the region captured successfully.

no setter

summaryPath → String

The path to the JSON summary artifact for this region.

final

topSelfFrames → List<ProfileFrameSummary>

The highest self-cost frames for the region.

final

topTotalFrames → List<ProfileFrameSummary>

The highest inclusive-cost frames for the region.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

Converts this region result to JSON.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited