Bourse.OptionReadiness.Report (bourse v0.1.0)

Copy Markdown View Source

Durable option-readiness matrix report.

Every cell and venue status links back to captured evidence. Reports are ordinary data plus JSON serialization — nothing is persisted automatically.

Orthogonal short-side capability (capabilities.short_fill_ready / side_status.short plus short_evidence) is serialized alongside the legacy scalar status without replacing it.

Summary

Types

t()

Functions

default_filename(report)

Default durable report filename for one run.

new(venues, observed_at, opts \\ [])

Builds a report from venue rows.

read(path)

Reads a previously written report.

to_map(report)

JSON-safe map representation with linked cell evidence.

write(report, path)

Writes pretty-printed JSON and returns the absolute path.

Types

t()

@type t() :: %Bourse.OptionReadiness.Report{
  meta: map(),
  observed_at: integer(),
  path: String.t() | nil,
  schema_version: pos_integer(),
  venues: [Bourse.OptionReadiness.VenueRow.t()]
}

Functions

default_filename(report)

@spec default_filename(t()) :: String.t()

Default durable report filename for one run.

new(venues, observed_at, opts \\ [])

@spec new([Bourse.OptionReadiness.VenueRow.t()], integer(), keyword()) :: t()

Builds a report from venue rows.

read(path)

@spec read(Path.t()) :: {:ok, t()} | {:error, term()}

Reads a previously written report.

to_map(report)

@spec to_map(t()) :: map()

JSON-safe map representation with linked cell evidence.

write(report, path)

@spec write(t(), Path.t()) :: {:ok, Path.t()} | {:error, term()}

Writes pretty-printed JSON and returns the absolute path.