Victoria.Trace (Victoria v0.2.0)

Copy Markdown View Source

A decoded ITF trace adapted for Victoria replay.

Trace structs are returned by load/1; consumers should not construct them directly because loading establishes the structural and value invariants required by the runner.

Summary

Types

metadata()

Normalized trace metadata retained from the ITF document.

t()

A finite trace, or a loaded lasso trace that replay will reject.

Functions

load(path)

Loads an ITF document and adapts its trace semantics for Victoria replay.

Types

metadata()

@type metadata() :: %{
  variables: [String.t()],
  parameters: [String.t()],
  source_format: :itf,
  itf: map()
}

Normalized trace metadata retained from the ITF document.

t()

@type t() :: %Victoria.Trace{
  loop_index: non_neg_integer() | nil,
  metadata: metadata(),
  source: Path.t(),
  steps: [Victoria.Step.t(), ...]
}

A finite trace, or a loaded lasso trace that replay will reject.

Functions

load(path)

@spec load(Path.t()) ::
  {:ok, t()} | {:error, ITF.Error.t() | Victoria.Trace.Error.t()}

Loads an ITF document and adapts its trace semantics for Victoria replay.