# `Obscura.Structured`
[🔗](https://github.com/hfiguera/obscura/blob/v0.2.0/lib/obscura/structured.ex#L1)

Public structured data redaction API.

# `analyze`

```elixir
@spec analyze(
  term(),
  keyword()
) :: {:ok, [Obscura.Structured.Item.t()]} | {:error, term()}
```

Recursively analyzes structured data and returns redaction items.

# `redact`

```elixir
@spec redact(
  term(),
  keyword()
) :: {:ok, Obscura.Structured.Result.t()} | {:error, term()}
```

Recursively redacts structured data.

---

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