SquidSonar.SquidMeshClient behaviour (squid_sonar v0.1.4)

Copy Markdown View Source

Client boundary for Squid Mesh public APIs.

Summary

Callbacks

explain_run(term, keyword)

@callback explain_run(
  term(),
  keyword()
) :: {:ok, SquidMesh.ReadModel.Explanation.Diagnostic.t()} | {:error, term()}

inspect_run(term, keyword)

@callback inspect_run(
  term(),
  keyword()
) :: {:ok, SquidMesh.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

inspect_run_graph(term, keyword)

@callback inspect_run_graph(
  term(),
  keyword()
) :: {:ok, SquidMesh.Runs.GraphInspection.t()} | {:error, term()}

list_runs(keyword, keyword)

@callback list_runs(keyword(), keyword()) ::
  {:ok, [SquidMesh.ReadModel.Listing.Summary.t()]} | {:error, term()}