# ferricstore_sdk v0.1.0 - Table of Contents

> Official Elixir SDK for FerricStore over the native ferric:// protocol.

## Modules

- [FerricStore](FerricStore.md): Elixir SDK for FerricStore and FerricFlow over the native `ferric://` protocol.

- [FerricStore.Client](FerricStore.Client.md): Native-protocol client.
- [FerricStore.Codec](FerricStore.Codec.md): Value codec behaviour used by Flow helpers.
- [FerricStore.Codec.Raw](FerricStore.Codec.Raw.md): Raw binary codec. Non-binary values are converted with `to_string/1`.

- [FerricStore.Codec.Term](FerricStore.Codec.Term.md): Erlang external term codec for Elixir-only applications.
- [FerricStore.Flow](FerricStore.Flow.md): High-level FerricFlow command helpers.
- [FerricStore.Protocol](FerricStore.Protocol.md): Encoder and decoder for the FerricStore native TCP protocol.
- [FerricStore.Queue](FerricStore.Queue.md): Queue-style API built on FerricFlow states.

- [FerricStore.Types](FerricStore.Types.md): Helpers for reading native protocol maps returned by FerricStore.

- [FerricStore.Workflow](FerricStore.Workflow.md): State-machine workflow convenience API.

- Exceptions
  - [FerricStore.Error](FerricStore.Error.md): Raised when FerricStore returns a protocol or command error.

