Struct HistorySource 

pub struct HistorySource { /* private fields */ }

Construct one, hand it an AuthorDirectory so actor ids resolve to people, and call HistorySource::entries whenever the document changes.

Implementations

impl HistorySource

pub fn entries_since( &self, doc: &mut AutoCommit, log: &mut HistoryLog, ) -> Vec<HistoryEntry>

Self::entries, reading only the changes log has not read yet. The rows are the same as Self::entries’ for the same document.

impl HistorySource

pub fn new() -> HistorySource

Every actor resolves to an unknown participant until registered.

pub fn without_field_paths(self) -> HistorySource

Describe a change that edited a document’s fields by how many it edited, never by their paths. A document’s own history names the fields for whoever inspects it; a feed read by people shows no storage keys.

pub fn without_record_genesis(self) -> HistorySource

Leave out a record’s genesis: the change that created it with its initial content, made by an actor derived from the record’s identity at time zero (for a package-primary document, which records no identity, the root change that stamps its store’s schema). A document’s own history keeps it as the version to restore to; a feed of what people did has no one to name for it.

pub fn with_authors(self, authors: AuthorDirectory) -> HistorySource

pub fn with_artifact_kind(self, kind: ArtifactKind) -> HistorySource

pub fn with_max_entries(self, max: usize) -> HistorySource

pub fn authors_mut(&mut self) -> &mut AuthorDirectory

So a long-lived producer can learn about a peer that joined after it was constructed.

pub fn authors(&self) -> &AuthorDirectory

pub fn entries(&self, doc: &mut AutoCommit) -> Vec<HistoryEntry>

Widgets sort for display differently (timeline newest-first, scrubber left-to-right), so this returns the document’s own causal order and lets them decide. Only committed changes are listed; pending edits stay in the live document until the app commits its action.

Trait Implementations

impl Default for HistorySource

fn default() -> HistorySource

Returns the “default value” for a type.