WalkOptions

Struct WalkOptions 

Source
pub struct WalkOptions {
    pub limit: Option<usize>,
    pub from_ref: Option<String>,
    pub since: Option<DateTime<Utc>>,
    pub until: Option<DateTime<Utc>>,
    pub include_diff: bool,
}
Expand description

Configuration for walking commits

Fields§

§limit: Option<usize>

Maximum number of commits to retrieve

§from_ref: Option<String>

Start from this commit (defaults to HEAD)

§since: Option<DateTime<Utc>>

Only include commits after this date

§until: Option<DateTime<Utc>>

Only include commits before this date

§include_diff: bool

Include diff information for each commit

Implementations§

Source§

impl WalkOptions

Source

pub fn latest(n: usize) -> Self

Create options for walking the N most recent commits

Source

pub fn with_diff(self) -> Self

Create options with diff extraction enabled

Source

pub fn from(self, reference: &str) -> Self

Set the starting reference

Source

pub fn since(self, date: DateTime<Utc>) -> Self

Filter commits since a date

Source

pub fn until(self, date: DateTime<Utc>) -> Self

Filter commits until a date

Trait Implementations§

Source§

impl Clone for WalkOptions

Source§

fn clone(&self) -> WalkOptions

Returns a duplicate 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 WalkOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WalkOptions

Source§

fn default() -> WalkOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

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<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.