# `LlmCall.Codec`
[🔗](https://github.com/gilbertwong96/llm_call/blob/main/lib/llm_call/codec.ex#L1)

The behaviour every dialect adapter implements.

A codec turns a canonical request into one protocol's wire request, and one
provider's response terms into canonical responses and stream events. It does
no IO: transports parse framing and decode JSON, codecs only map terms.

Streaming callbacks are optional so a non-streaming codec need not implement
dummy functions; `LlmCall` returns a typed error when a caller asks a codec
for streaming it does not implement.

Streaming state is passed as `LlmCall.StreamState`, which the codec reads with
`LlmCall.StreamState.data/1` and rebuilds with `LlmCall.StreamState.new/2`.

# `capabilities`

```elixir
@callback capabilities(
  LlmCall.Request.t(),
  LlmCall.Config.t()
) :: LlmCall.Capabilities.t()
```

# `decode_error`

```elixir
@callback decode_error(
  LlmCall.wire_value(),
  LlmCall.Config.t()
) :: LlmCall.Error.t()
```

# `decode_response`

```elixir
@callback decode_response(
  LlmCall.wire_value(),
  LlmCall.Config.t()
) :: {:ok, LlmCall.Response.t()} | {:error, LlmCall.Error.t()}
```

# `decode_stream_event`
*optional* 

```elixir
@callback decode_stream_event(
  LlmCall.wire_value(),
  LlmCall.Config.t(),
  LlmCall.StreamState.t()
) ::
  {:ok, [LlmCall.StreamEvent.t()], LlmCall.StreamState.t()}
  | {:done, LlmCall.StreamState.t()}
  | {:error, LlmCall.Error.t()}
```

# `encode_request`

```elixir
@callback encode_request(
  LlmCall.Request.t(),
  LlmCall.Config.t()
) :: {:ok, LlmCall.EncodedRequest.t()} | {:error, LlmCall.Error.t()}
```

# `finish_stream`
*optional* 

```elixir
@callback finish_stream(
  LlmCall.StreamState.t(),
  LlmCall.Config.t()
) ::
  {:ok, [LlmCall.StreamEvent.t()], LlmCall.StreamState.t()}
  | {:error, LlmCall.Error.t()}
```

# `info`

```elixir
@callback info() :: LlmCall.Codec.Info.t()
```

# `init_stream`
*optional* 

```elixir
@callback init_stream(
  LlmCall.Request.t(),
  LlmCall.Config.t()
) :: {:ok, LlmCall.StreamState.t()} | {:error, LlmCall.Error.t()}
```

# `validate_request`

```elixir
@callback validate_request(
  LlmCall.Request.t(),
  LlmCall.Config.t()
) :: :ok | {:error, LlmCall.Error.t()}
```

---

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