# `Decree.Store.ReadResult`
[🔗](https://github.com/sparkle-space/decree/blob/v0.1.0/lib/decree/store/read_result.ex#L1)

What `c:Decree.Store.read_query/2` answers, all of it from one database snapshot.

## Fields

  - `events` - the matching `Decree.Store.RecordedEvent`s, in the read's direction.
    `event_number` is the event's `$all` position, and `stream_uuid` and
    `stream_version` are its original stream's, exactly as a row of
    `c:Decree.Store.read_all_streams_forward/3`. A match only the read's
    `position_items` matched has no event here, only its entries in the maps below.
  - `after` - the `$all` head at the read's snapshot. It is not the last match: an
    event that does not match still moves it.
  - `read_at` - a `DateTime`, the database's clock when the read ran, taken once.
  - `command_stamps` - `%{position => stamp}` for each match carrying the read's
    `command_tag`. A match without that tag has no entry. A `nil` stamp means the
    tag's row carries no stamp, which is not the same as having no row.
  - `matched_items` - `%{position => indexes}`, the sorted 0-based indexes of the
    items that matched each match, the ones `position_items` answers with no event
    included.
  - `tags` - `%{position => tags}` for each match one of the read's `tag_items` matched,
    its tags sorted bytewise, from the same snapshot as the rest. It leaves out what
    `c:Decree.Store.read_tags/2` leaves out, so a position with no tag left, or one no
    `tag_items` item matched, has no entry. `%{}` when the read names no `tag_items`.

# `position`

```elixir
@type position() :: non_neg_integer()
```

# `t`

```elixir
@type t() :: %Decree.Store.ReadResult{
  after: non_neg_integer(),
  command_stamps: %{required(position()) =&gt; DateTime.t() | nil},
  events: [Decree.Store.RecordedEvent.t()],
  matched_items: %{required(position()) =&gt; [non_neg_integer()]},
  read_at: DateTime.t(),
  tags: %{required(position()) =&gt; [String.t()]}
}
```

---

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