Insider.Protocol (Insider v0.1.0)

Copy Markdown View Source

Versioned request and effect-honest result constructors.

Transport adapters must validate through this module rather than converting external strings to atoms.

Summary

Functions

cancelled(request, options \\ [])

decode_request(payload)

@spec decode_request(term()) ::
  {:ok, Insider.Protocol.Request.t()} | {:error, Insider.Protocol.Error.t()}

failure(request, error, options \\ [])

operations()

@spec operations() :: [String.t()]

request(operation, options \\ [])

@spec request(String.t(), keyword()) ::
  {:ok, Insider.Protocol.Request.t()} | {:error, Insider.Protocol.Error.t()}

success(request, value, options \\ [])

timeout(request, options \\ [])

unsupported(request, capability)

version()

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