# `ExSandbox.Sandbox`
[🔗](https://github.com/FoundryStack/ex_sandbox/blob/v1.2.0/lib/ex_sandbox/sandbox.ex#L1)

The struct every `ExSandbox.Mechanism` callback receives (012 T012).

Carries **only what a mechanism needs to do its job**, which is materially
less than what a host application stores about a sandbox. This replaces
`003`'s `SandboxRecord.t()` in the mechanism contract (research R3) — that
type was an Ash resource struct, and `FR-001` forbids `ex_sandbox` an Ash
dependency.

## Deliberately absent

`environment_id`, `data_store_ref`, `data_store_placement`, tenant
attribution, `last_request_at`, `state_changed_at`. Each exists in `003`'s
data model and stays in the consumer's own data layer -- in the originating
application, a separate `ash_sandbox` package; anywhere else, the host. A mechanism
that needed any of them would be reaching into host concepts, which is the
dependency direction this library exists to prevent.

## Opaque fields

`owner_ref`, `mechanism_ref`, and `context` are stored, compared, and
propagated — never parsed, and never used to make a decision (`FR-007`,
`FR-003`). `owner_ref` is a bare binary rather than a richer type for exactly
this reason: any structure is an invitation to interpret it.

# `t`

```elixir
@type t() :: %ExSandbox.Sandbox{
  context: term(),
  cpu_limit: non_neg_integer() | nil,
  disk_quota_mb: non_neg_integer() | nil,
  id: String.t(),
  mechanism_ref: String.t() | nil,
  memory_limit_mb: non_neg_integer() | nil,
  owner_ref: String.t(),
  service_port: :inet.port_number() | nil,
  template_ref: String.t(),
  workspace_path: String.t() | nil
}
```

---

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