Skip to main content

HistoryWalk

Struct HistoryWalk 

Source
pub struct HistoryWalk<'a> { /* private fields */ }
Available on crate feature workflow only.
Expand description

Builder for one history walk. Configure with the chained setters, then call execute.

Implementations§

Source§

impl<'a> HistoryWalk<'a>

Source

pub fn max_count(self, n: u32) -> Self

Limit results to the most recent n commits.

Source

pub fn skip(self, n: u32) -> Self

Skip the first n commits before collecting.

Source

pub fn since(self, s: impl Into<String>) -> Self

Filter by --since (any value git log accepts, e.g. "2.weeks.ago").

Source

pub fn until(self, s: impl Into<String>) -> Self

Filter by --until.

Source

pub fn author(self, s: impl Into<String>) -> Self

Filter by author (--author).

Source

pub fn grep(self, s: impl Into<String>) -> Self

Filter by commit-message grep (--grep).

Source

pub fn revision(self, r: impl Into<String>) -> Self

Add a revision, range, or ref (e.g. "HEAD~10..HEAD"). Multiple calls accumulate.

Source

pub fn path(self, p: impl Into<String>) -> Self

Restrict to commits touching path. Multiple calls accumulate.

Source

pub fn reverse(self) -> Self

Reverse the output order (--reverse).

Source

pub async fn execute(self) -> Result<Vec<Commit>>

Spawn git log with the configured filters and parse the result.

Trait Implementations§

Source§

impl<'a> Debug for HistoryWalk<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for HistoryWalk<'a>

§

impl<'a> RefUnwindSafe for HistoryWalk<'a>

§

impl<'a> Send for HistoryWalk<'a>

§

impl<'a> Sync for HistoryWalk<'a>

§

impl<'a> Unpin for HistoryWalk<'a>

§

impl<'a> UnsafeUnpin for HistoryWalk<'a>

§

impl<'a> UnwindSafe for HistoryWalk<'a>

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§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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