SnakeBridge.RuntimeClient behaviour (SnakeBridge v0.16.0)

Behaviour for runtime clients that execute SnakeBridge payloads.

The default runtime client is Snakepit, but tests can override this via the :runtime_client config or a per-process override.

Summary

callback()

opts()

payload()

tool()

@type callback() :: (term() -> any())

@type opts() :: keyword()

@type payload() :: map()

@type tool() :: String.t()

@callback execute(tool(), payload(), opts()) ::
  {:ok, term()} | {:error, Snakepit.Error.t()}

@callback execute_stream(tool(), payload(), callback(), opts()) ::
  :ok | {:error, Snakepit.Error.t()}