# `Firkin.Backends.Memory`
[🔗](https://harton.dev/james/firkin)

Reference implementation of `Firkin.Backend` — stores credentials,
buckets, objects, and multipart uploads in a named ETS table.

This module exists for three purposes:

  1. **Reference** — every callback in `Firkin.Backend` has a working
     implementation here. Read the source if you're unsure how your
     own backend should shape its return values (`Firkin.Object`,
     `Firkin.ListResult`, `Firkin.DeleteResult`, etc.).

  2. **Manual testing** — the default backend for `mix firkin.serve`,
     letting you drive Firkin from `aws` CLI / `mc` / any S3 client
     without writing a storage layer first.

  3. **Test double** — downstream projects using Firkin-compatible
     tooling can point their tests at this backend instead of
     standing up MinIO.

**Not for production use.** All state lives in a single ETS table and
disappears when the owning BEAM process exits. No concurrency controls
beyond ETS atomicity. No persistence. No quotas. No pagination for
`ListObjectsV2`, `ListMultipartUploads`, or `ListParts`.

## Usage

    Firkin.Backends.Memory.start()
    Firkin.Backends.Memory.add_credential("AKID", "SECRET")

    forward "/s3", Firkin.Plug,
      backend: Firkin.Backends.Memory,
      region: "us-east-1"

Implements the streaming variants of `put_object_stream/5` and
`upload_part_stream/6`, so the Plug's `:max_buffered_put_bytes` cap
is bypassed when this backend is used.

# `add_credential`

```elixir
@spec add_credential(String.t(), String.t()) :: :ok
```

Registers an access-key/secret-key credential pair. The identity
stored alongside is `%{user: access_key_id}` — adequate for demos.

# `reset`

```elixir
@spec reset() :: :ok
```

Clears all stored state. Leaves the ETS table in place.

# `start`

```elixir
@spec start() :: :ok
```

Creates the ETS table if it does not exist and resets all state.

---

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