Struct branchless::git::Commit

source · [−]

pub struct Commit<'repo> { /* private fields */ }

Expand description

Represents a commit object in the Git object database.

Implementations

source

impl<'repo> Commit<'repo>

source

pub fn get_oid(&self) -> NonZeroOid

Get the object ID of the commit.

source

pub fn get_short_oid(&self) -> Result<String>

Get the short object ID of the commit.

source

pub fn get_parent_oids(&self) -> Vec<NonZeroOid>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the object IDs of the parents of this commit.

source

pub fn get_only_parent_oid(&self) -> Option<NonZeroOid>

Get the parent OID of this commit if there is exactly one parent, or None otherwise.

source

pub fn get_parent_count(&self) -> usize

Get the number of parents of this commit.

source

pub fn get_parents(&self) -> Vec<Commit<'repo>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get the parent commits of this commit.

source

pub fn get_only_parent(&self) -> Option<Commit<'repo>>

Get the parent of this commit if there is exactly one parent, or None otherwise.

source

pub fn get_time(&self) -> Time

Get the commit time of this commit.

source

pub fn get_summary(&self) -> Result<OsString>

Get the summary (first line) of the commit message.

source

pub fn get_message_pretty(&self) -> Result<OsString>

Get the commit message with some whitespace trimmed.

source

pub fn get_message_raw(&self) -> Result<OsString>

Get the commit message, without any whitespace trimmed.

source

pub fn get_author(&self) -> Signature<'_>

Get the author of this commit.

source

pub fn get_committer(&self) -> Signature<'_>

Get the committer of this commit.

source

pub fn get_tree(&self) -> Result<Tree<'_>>

Get the Tree object associated with this commit.

source

pub fn friendly_describe(&self, glyphs: &Glyphs) -> Result<StyledString>

Print a one-line description of this commit containing its OID and summary.

source

pub fn friendly_preview(&self) -> Result<StyledString>

Get a multi-line description of this commit containing information about its OID, author, commit time, and message.

source

pub fn is_empty(&self) -> bool

Determine if the current commit is empty (has no changes compared to its parent).

source

pub fn contains_touched_path(&self, path: &Path) -> Result<Option<bool>>

Determine if this commit added, removed, or changed the entry at the provided file path.

source

pub fn amend_commit(
 &self,
 update_ref: Option<&str>,
 author: Option<&Signature<'_>>,
 committer: Option<&Signature<'_>>,
 message: Option<&str>,
 tree: Option<&Tree<'_>>
) -> Result<NonZeroOid>

Amend this existing commit. Returns the OID of the resulting new commit.

Trait Implementations

source

impl<'repo> Clone for Commit<'repo>

source

fn clone(&self) -> Commit<'repo>

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<'repo> Debug for Commit<'repo>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'repo> RefUnwindSafe for Commit<'repo>

impl<'repo> !Send for Commit<'repo>

impl<'repo> !Sync for Commit<'repo>

impl<'repo> Unpin for Commit<'repo>

impl<'repo> UnwindSafe for Commit<'repo>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
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 T where
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

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 T where
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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T, U> TryFrom for T where
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 T where
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 T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> With for T

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

Calls the given closure and return the result. Read more

fn with<F>(self, f: F) -> Self where
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) -> Self where
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

Struct branchless::git::Commit

Implementations

impl<'repo> Commit<'repo>

pub fn get_oid(&self) -> NonZeroOid

pub fn get_short_oid(&self) -> Result<String>

pub fn get_parent_oids(&self) -> Vec<NonZeroOid>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_only_parent_oid(&self) -> Option<NonZeroOid>

pub fn get_parent_count(&self) -> usize

pub fn get_parents(&self) -> Vec<Commit<'repo>>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn get_only_parent(&self) -> Option<Commit<'repo>>

pub fn get_time(&self) -> Time

pub fn get_summary(&self) -> Result<OsString>

pub fn get_message_pretty(&self) -> Result<OsString>

pub fn get_message_raw(&self) -> Result<OsString>

pub fn get_author(&self) -> Signature<'_>

pub fn get_committer(&self) -> Signature<'_>

pub fn get_tree(&self) -> Result<Tree<'_>>

pub fn friendly_describe(&self, glyphs: &Glyphs) -> Result<StyledString>

pub fn friendly_preview(&self) -> Result<StyledString>

pub fn is_empty(&self) -> bool

pub fn contains_touched_path(&self, path: &Path) -> Result<Option<bool>>

pub fn amend_commit( &self, update_ref: Option<&str>, author: Option<&Signature<'_>>, committer: Option<&Signature<'_>>, message: Option<&str>, tree: Option<&Tree<'_>>) -> Result<NonZeroOid>

Trait Implementations

impl<'repo> Clone for Commit<'repo>

fn clone(&self) -> Commit<'repo>

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

impl<'repo> Debug for Commit<'repo>

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

Auto Trait Implementations

impl<'repo> RefUnwindSafe for Commit<'repo>

impl<'repo> !Send for Commit<'repo>

impl<'repo> !Sync for Commit<'repo>

impl<'repo> Unpin for Commit<'repo>

impl<'repo> UnwindSafe for Commit<'repo>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

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

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where 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 T where 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>

pub fn get_parent_oids(&self) -> Vec<NonZeroOid>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn get_parents(&self) -> Vec<Commit<'repo>>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn amend_commit(
&self,
update_ref: Option<&str>,
author: Option<&Signature<'_>>,
committer: Option<&Signature<'_>>,
message: Option<&str>,
tree: Option<&Tree<'_>>
) -> Result<NonZeroOid>

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

impl<T> AsAny for T where
T: Any,

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

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

impl<T, U> Into<U> for T where
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 T where
T: Clone,

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

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

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

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

fn with<F>(self, f: F) -> Self where
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) -> Self where
F: FnOnce(&mut Self),

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