ProfileFormatter
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
ProfileFormatter.type
Members list
Value members
Concrete methods
Source files referenced by data, loaded best-effort (only files readable from the current working directory) so the HTML report can annotate them with per-line cost.
Source files referenced by data, loaded best-effort (only files readable from the current working directory) so the HTML report can annotate them with per-line cost.
Value parameters
- include
-
keep only files whose path satisfies this predicate. Use it to skip framework/library sources and annotate only your own contract — e.g.
!_.contains("/scalus-core/"). For projects that depend on Scalus as a published artifact, library sources live in jars and are already excluded (they are not readable files).
Attributes
Compact summary suitable for console / log output: total budget plus the top-N by CPU.
Compact summary suitable for console / log output: total budget plus the top-N by CPU.
Attributes
Renders profiling data as CSV (one diffable file across all sections). When the data carries execution unit prices, a trailing fee column (lovelace) is added.
Renders profiling data as CSV (one diffable file across all sections). When the data carries execution unit prices, a trailing fee column (lovelace) is added.
Attributes
Renders profiling data as a self-contained HTML page (no source annotation).
Renders profiling data as a self-contained HTML page (no source annotation).
Attributes
Renders profiling data as a self-contained, interactive HTML page.
Renders profiling data as a self-contained, interactive HTML page.
The page bundles its own CSS/JS (no external dependencies): sortable, filterable tables with %-of-CPU bars, a cost-ranked hot-edges table, and — when source text is supplied — a per-line cost-annotated source view (the flagship view).
Value parameters
- data
-
the profiling data
- sources
-
optional
file -> source lines(linenis elementn - 1); profiled files present here are rendered with per-line cost annotations - title
-
optional label identifying what was profiled (e.g. the contract and test-case name). When non-empty it is shown in the page `` and as a subtitle above the report.
Attributes
Renders the full profiling data as JSON (machine-readable, schema version JsonSchemaVersion). When the data carries execution unit prices, every entry and the total also include a derived "fee" in lovelace.
Renders the full profiling data as JSON (machine-readable, schema version JsonSchemaVersion). When the data carries execution unit prices, every entry and the total also include a derived "fee" in lovelace.
Attributes
Renders profiling data as a formatted text table.
Renders profiling data as a formatted text table.
Value parameters
- data
-
The profiling data
- maxRows
-
Maximum rows to display per section (default 50)
Attributes
- Returns
-
Formatted text output
Write the CSV rendering to path (creating parent dirs).
Write the CSV rendering to path (creating parent dirs).
Attributes
Write a self-contained, source-annotated HTML report to path (creating parent dirs).
Write a self-contained, source-annotated HTML report to path (creating parent dirs).
Value parameters
- include
-
source-file filter for the annotated-source view (see loadSources)
- title
-
optional label identifying what was profiled (e.g. the contract and test-case name); shown in the page `` and as a subtitle above the report (see toHtml)
Attributes
Write the JSON rendering to path (creating parent dirs).
Write the JSON rendering to path (creating parent dirs).
Attributes
Concrete fields
Version of the profile.json document produced by toJson (emitted as its "schemaVersion" field). Bump on any incompatible change to the JSON shape so consumers (e.g. the Scalus VS Code extension) can detect and reject profiles they don't understand.
Version of the profile.json document produced by toJson (emitted as its "schemaVersion" field). Bump on any incompatible change to the JSON shape so consumers (e.g. the Scalus VS Code extension) can detect and reject profiles they don't understand.