# `Insider.Protocol`
[🔗](https://github.com/hiivemarkets/insider/blob/v0.1.0/lib/insider/protocol.ex#L1)

Versioned request and effect-honest result constructors.

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

# `cancelled`

```elixir
@spec cancelled(Insider.Protocol.Request.t(), keyword()) ::
  Insider.Protocol.Result.t()
```

# `decode_request`

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

# `failure`

```elixir
@spec failure(Insider.Protocol.Request.t(), Insider.Protocol.Error.t(), keyword()) ::
  Insider.Protocol.Result.t()
```

# `operations`

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

# `request`

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

# `success`

```elixir
@spec success(Insider.Protocol.Request.t(), term(), keyword()) ::
  Insider.Protocol.Result.t()
```

# `timeout`

```elixir
@spec timeout(Insider.Protocol.Request.t(), keyword()) :: Insider.Protocol.Result.t()
```

# `unsupported`

```elixir
@spec unsupported(Insider.Protocol.Request.t(), atom()) :: Insider.Protocol.Result.t()
```

# `version`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*
