# `Exograph.Hit`
[🔗](https://github.com/elixir-vibe/exograph/blob/v0.2.0/lib/exograph/hit.ex#L1)

Candidate or verified search hit.

## Hit type hierarchy

Exograph returns typed hit structs depending on the search function:

- `Exograph.Hit` — structural pattern/selector match from `Exograph.search/3`
- `Exograph.TextHit` — source text match from `search_text/3`
- `Exograph.CommentHit` — comment match from `search_comments/3`
- `Exograph.DefinitionHit` — definition name match from `search_definitions/3`
- `Exograph.ReferenceHit` — reference name match from `search_references/3`
- `Exograph.CallEdgeHit` — call graph edge from `search_callers/3` / `search_callees/3`

All hit types expose `:fragment`, `:score`, and `:match` fields.

# `t`

```elixir
@type t() :: %Exograph.Hit{
  fragment: Exograph.Fragment.t() | nil,
  fragment_id: Exograph.Fragment.id() | nil,
  match: term(),
  matched_terms: [String.t()],
  score: number()
}
```

# `new`

# `with_match`

---

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