Skip to main content

made_api/
recollection_view.rs

1use serde::{Deserialize, Serialize};
2
3use crate::RecalledEntryView;
4
5/// What earlier sessions in a ceremony's memory scope decided, as that
6/// ceremony was told when it opened.
7///
8/// Absent from a summary when the ceremony was told nothing, which is
9/// every ceremony that declares no `memory_scope` in its context: the
10/// default scope is the ceremony's own id and nobody else writes there.
11#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
12pub struct RecollectionView {
13    /// The memory this ceremony reads and writes, as `kind:name`.
14    pub scope: String,
15    pub entries: Vec<RecalledEntryView>,
16    /// Whether the budget stopped the rendering before the scope ran
17    /// out. A consumer weighing what earlier sessions decided has to
18    /// know whether it is looking at the whole record or the front of
19    /// it.
20    pub truncated: bool,
21}