Enum branchless::core::eventlog::Event

source · [−]

pub enum Event {
    RewriteEvent {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        old_commit_oid: MaybeZeroOid,
        new_commit_oid: MaybeZeroOid,
    },
    RefUpdateEvent {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        ref_name: ReferenceName,
        old_oid: MaybeZeroOid,
        new_oid: MaybeZeroOid,
        message: Option<ReferenceName>,
    },
    CommitEvent {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        commit_oid: NonZeroOid,
    },
    ObsoleteEvent {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        commit_oid: NonZeroOid,
    },
    UnobsoleteEvent {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        commit_oid: NonZeroOid,
    },
    WorkingCopySnapshot {
        timestamp: f64,
        event_tx_id: EventTransactionId,
        head_oid: MaybeZeroOid,
        commit_oid: NonZeroOid,
        ref_name: Option<ReferenceName>,
    },
}

Expand description

An event that occurred to one of the commits in the repository.

Variants

`RewriteEvent`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

old_commit_oid: MaybeZeroOid

The OID of the commit before the rewrite.

new_commit_oid: MaybeZeroOid

The OID of the commit after the rewrite.

Indicates that the commit was rewritten.

Examples of rewriting include rebases and amended commits.

We typically want to mark the new version of the commit as active and the old version of the commit as obsolete.

`RefUpdateEvent`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

ref_name: ReferenceName

The full name of the reference that was updated.

For example, HEAD or refs/heads/master.

old_oid: MaybeZeroOid

The old referent OID.

new_oid: MaybeZeroOid

The updated referent OID.

message: Option<ReferenceName>

A message associated with the rewrite, if any.

Indicates that a reference was updated.

The most important reference we track is HEAD. In principle, we can also track branch moves in this way, but Git doesn’t support the appropriate hook until v2.29 (reference-transaction).

`CommitEvent`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

commit_oid: NonZeroOid

The new commit OID.

Indicate that the user made a commit.

User commits should be marked as active.

`ObsoleteEvent`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

commit_oid: NonZeroOid

The OID of the commit that was obsoleted.

Indicates that a commit was explicitly obsoleted by the user.

If the commit in question was not already active, then this has no practical effect.

`UnobsoleteEvent`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

commit_oid: NonZeroOid

The OID of the commit that was unobsoleted.

Indicates that a commit was explicitly un-obsoleted by the user.

If the commit in question was not already obsolete, then this has no practical effect.

`WorkingCopySnapshot`

Fields

timestamp: f64

The timestamp of the event.

event_tx_id: EventTransactionId

The transaction ID of the event.

head_oid: MaybeZeroOid

The OID of the current HEAD commit.

commit_oid: NonZeroOid

The OID of the commit containing metadata about the working copy snapshot.

ref_name: Option<ReferenceName>

The name of the checked-out branch, if any. This should be a full reference name like refs/heads/foo.

Represents a snapshot of the working copy made at a certain time, typically before a potentially-destructive operation.

Implementations

source

impl Event

source

pub fn get_timestamp(&self) -> SystemTime

Get the timestamp associated with this event.

source

pub fn get_event_tx_id(&self) -> EventTransactionId

Get the event transaction ID associated with this event.

Trait Implementations

source

impl Clone for Event

source

fn clone(&self) -> Event

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Event

source

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

Formats the value using the given formatter. Read more

source

impl PartialEq<Event> for Event

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl StructuralPartialEq for Event

Auto Trait Implementations

impl Send for Event

impl Sync for Event

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

Set the background color generically. Read more

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> With for T

fn wrap_with<U, F>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more

fn with<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),

Calls the given closure on self.

fn try_with<E, F>(self, f: F) -> Result<Self, E>where
F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.

fn with_if<F>(self, condition: bool, f: F) -> Selfwhere
F: FnOnce(&mut Self),

Calls the given closure if condition == true.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Enum branchless::core::eventlog::Event

Variants

RewriteEvent

Fields

RefUpdateEvent

Fields

CommitEvent

Fields

ObsoleteEvent

Fields

UnobsoleteEvent

Fields

WorkingCopySnapshot

Fields

Implementations

impl Event

pub fn get_timestamp(&self) -> SystemTime

pub fn get_event_tx_id(&self) -> EventTransactionId

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

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

impl Debug for Event

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

impl PartialEq<Event> for Event

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

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

impl StructuralPartialEq for Event

Auto Trait Implementations

impl RefUnwindSafe for Event

impl Send for Event

impl Sync for Event

impl Unpin for Event

impl UnwindSafe for Event

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

`RewriteEvent`

`RefUpdateEvent`

`CommitEvent`

`ObsoleteEvent`

`UnobsoleteEvent`

`WorkingCopySnapshot`

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn wrap_with<U, F>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,

fn with<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),

fn try_with<E, F>(self, f: F) -> Result<Self, E>where
F: FnOnce(&mut Self) -> Result<(), E>,

fn with_if<F>(self, condition: bool, f: F) -> Selfwhere
F: FnOnce(&mut Self),

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,