SquidSonar.SquidMeshClient behaviour (squid_sonar v0.1.1)

Copy Markdown View Source

Client boundary for Squid Mesh public APIs.

Summary

Callbacks

explain_run(term, keyword)
inspect_run(term, keyword)
list_runs(keyword, keyword)

Callbacks

explain_run(term, keyword)

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

inspect_run(term, keyword)

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

list_runs(keyword, keyword)

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