Enum EventTransactionId

pub enum EventTransactionId {
    Id(isize),
    Suppressed,
}

The ID associated with the transactions that created an event.

A “event transaction” is a group of logically-related events. For example, during a rebase operation, all of the rebased commits have different CommitEvents, but should belong to the same transaction. This improves the experience for git undo, since the user probably wants to see or undo all of the logically-related events at once, rather than individually.

Note that some logically-related events may not be included together in the same transaction. For example, if a rebase is interrupted due to a merge conflict, then the commits applied due to git rebase and the commits applied due to git rebase --continue may not share the same transaction. In this sense, a transaction is “best-effort”.

Unlike in a database, there is no specific guarantee that an event transaction is an atomic unit of work.

Variants

Id(isize)

A normal transaction ID.

Suppressed

A value indicating that the no events should actually be added for this transaction.

Trait Implementations

impl Clone for EventTransactionId

fn clone(&self) -> EventTransactionId

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventTransactionId

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

Formats the value using the given formatter.

impl Display for EventTransactionId

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

Formats the value using the given formatter.

impl FromStr for EventTransactionId

type Err = <isize as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for EventTransactionId

fn eq(&self, other: &EventTransactionId) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for EventTransactionId

impl Eq for EventTransactionId

impl StructuralPartialEq for EventTransactionId