Struct git_cliff_core::repo::Repository

source · [−]

pub struct Repository { /* private fields */ }

Expand description

Wrapper for Repository type from git2.

Implementations

source

impl Repository

source

pub fn init(path: PathBuf) -> Result<Self>

Initializes (opens) the repository.

source

pub fn commits(
 &self,
 range: Option<String>,
 include_path: Option<Vec<Pattern>>,
 exclude_path: Option<Vec<Pattern>>
) -> Result<Vec<Commit<'_>>>

Parses and returns the commits.

Sorts the commits by their time.

source

pub fn current_tag(&self) -> Option<String>

Returns the current tag.

It is the same as running git describe --tags

source

pub fn tags(
 &self,
 pattern: &Option<String>,
 date_order: bool
) -> Result<IndexMap<String, String>>

Parses and returns a commit-tag map.

It collects lightweight and annotated tags.

Auto Trait Implementations

impl RefUnwindSafe for Repository

impl Send for Repository

impl !Sync for Repository

impl Unpin for Repository

impl UnwindSafe for Repository

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,

const: unstable · 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, 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.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

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.

Struct git_cliff_core::repo::Repository

Implementations

impl Repository

pub fn init(path: PathBuf) -> Result<Self>

pub fn commits(
    &self,
    range: Option<String>,
    include_path: Option<Vec<Pattern>>,
    exclude_path: Option<Vec<Pattern>>
) -> Result<Vec<Commit<'_>>>

pub fn current_tag(&self) -> Option<String>

pub fn tags(
    &self,
    pattern: &Option<String>,
    date_order: bool
) -> Result<IndexMap<String, String>>

Auto Trait Implementations

impl RefUnwindSafe for Repository

impl Send for Repository

impl !Sync for Repository

impl Unpin for Repository

impl UnwindSafe for Repository

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

Struct git_cliff_core::repo::Repository

Implementations

impl Repository

pub fn init(path: PathBuf) -> Result<Self>

pub fn commits( &self, range: Option<String>, include_path: Option<Vec<Pattern>>, exclude_path: Option<Vec<Pattern>>) -> Result<Vec<Commit<'_>>>

pub fn current_tag(&self) -> Option<String>

pub fn tags( &self, pattern: &Option<String>, date_order: bool) -> Result<IndexMap<String, String>>

Auto Trait Implementations

impl RefUnwindSafe for Repository

impl Send for Repository

impl !Sync for Repository

impl Unpin for Repository

impl UnwindSafe for Repository

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

pub fn commits(
&self,
range: Option<String>,
include_path: Option<Vec<Pattern>>,
exclude_path: Option<Vec<Pattern>>
) -> Result<Vec<Commit<'_>>>

pub fn tags(
&self,
pattern: &Option<String>,
date_order: bool
) -> Result<IndexMap<String, String>>

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

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

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