Struct EventReplayer

pub struct EventReplayer { /* private fields */ }

Processes events in order and determine the repo’s visible commits.

Implementations

impl EventReplayer

pub fn from_event_log_db( effects: &Effects, repo: &Repo, event_log_db: &EventLogDb<'_>, ) -> Result<Self>

Construct the replayer from all the events in the database.

Args:

• event_log_db: The database to query events from.

Returns: The constructed replayer.

pub fn process_event(&mut self, event: &Event)

Process the given event.

This also sets the event cursor to point to immediately after the event that was just processed.

Args:

• event: The next event to process. Events should be passed to the
• replayer in order from oldest to newest.

pub fn get_cursor_commit_activity_status( &self, cursor: EventCursor, oid: NonZeroOid, ) -> CommitActivityStatus

Determines whether a commit is considered “active” at the cursor’s point in time.

pub fn get_cursor_commit_latest_event( &self, cursor: EventCursor, oid: NonZeroOid, ) -> Option<&Event>

Get the latest event affecting a given commit, as of the cursor’s point in time.

Args:

• oid: The OID of the commit to check.

Returns: The most recent event that affected that commit. If this commit was not observed by the replayer, returns None.

pub fn get_cursor_oids(&self, cursor: EventCursor) -> HashSet<NonZeroOid>

Get all OIDs which have been observed so far. This should be the set of non-inactive commits.

pub fn make_default_cursor(&self) -> EventCursor

Create an event cursor pointing to immediately after the last event.

pub fn make_cursor(&self, event_id: isize) -> EventCursor

Create an event cursor pointing to immediately after the provided event ID.

If the event ID is too low or too high, it will be clamped to the valid range for event IDs.

pub fn advance_cursor( &self, cursor: EventCursor, num_events: isize, ) -> EventCursor

Advance the event cursor by the specified number of events.

Args:

• num_events: The number of events to advance by. Can be positive, zero, or negative. If out of bounds, the cursor is set to the first or last valid position, as appropriate.

pub fn advance_cursor_by_transaction( &self, cursor: EventCursor, num_transactions: isize, ) -> EventCursor

Advance the cursor to the transaction which is num_transactions after the current cursor. num_transactions can be negative.

The returned cursor will point to the position immediately after the last event in the subsequent transaction.

pub fn get_references_snapshot( &self, repo: &Repo, cursor: EventCursor, ) -> Result<RepoReferencesSnapshot>

Get the RepoReferencesSnapshot at the cursor’s point in time.

pub fn get_event_before_cursor( &self, cursor: EventCursor, ) -> Option<(isize, &Event)>

Get the event immediately before the cursor.

Returns: A tuple of event ID and the event that most recently happened. If no event was before the event cursor, returns None instead.

pub fn get_tx_events_before_cursor( &self, cursor: EventCursor, ) -> Option<(isize, &[Event])>

Get all the events in the transaction immediately before the cursor.

Returns: A tuple of event ID and the events that happened in the most recent transaction. The event ID corresponds to the ID of the first event in the returned list of events. If there were no events before the event cursor (and therefore no transactions), returns None instead.

pub fn get_events_since_cursor(&self, cursor: EventCursor) -> &[Event]

Get all the events that have happened since the event cursor.

Returns: An ordered list of events that have happened since the event cursor, from least recent to most recent.

Trait Implementations

impl Debug for EventReplayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.