Struct Repo 

pub struct Repo { /* private fields */ }

Implementations

impl Repo

pub fn new<S: AsRef<OsStr> + ?Sized>(s: &S) -> Self

Create a new instance of a Repository

Examples:

use gitstats::Repo;
fn main() {
    let repo_dir = "#/custom/path/to/repo";
    let repo = Repo::from(&repo_dir);
}

pub fn to_str(&self) -> Option<&str>

pub fn fetch(&self) -> Result<()>

Fetch the repository using the default remote

Examples:

use gitstats::Repo;

fn main() {
    let repo_dir = "/custom/path/to/repo";
    let repo = Repo::from(&repo_dir);
    match repo.fetch() {
        Ok(_) => println!("fetch complete"),
        Err(err) => println!("Error: {err}"),
    }
}

pub fn fetch_all(&self) -> Result<()>

Fetch all the remotes

pub fn list_commits(&self, options: CommitArgs) -> Result<Vec<CommitHash>>

Returns a list of commits based on the input arguments

Examples:

use gitstats::Repo;
use gitstats::CommitArgs;

fn main() {
let repo_dir = "/custom/path/to/repo";
    let repo = Repo::from(&repo_dir);
	let commit_args = CommitArgs::default();
    match repo.list_commits(commit_args) {
        Ok(commits) => println!("got commits: {commits}"),
        Err(err) => println!("Error: {err}"),
    }
}

pub fn first_commit(&self) -> Result<Option<CommitDetail>>

pub fn last_commit(&self) -> Result<Option<CommitDetail>>

pub fn size(&self) -> Result<u64>

Return the repository size (in Kilobytes)

pub fn commits_count(&self) -> Result<usize>

Returns the total commits

pub fn details(&self) -> Result<Detail>

pub fn commits_stats( &self, commits: &Vec<CommitHash>, ) -> Result<Vec<CommitDetail>>

Extract details from a list of commits

Examples:

use gitstats::Repo;
use gitstats::CommitArgs;

fn main() {
let repo_dir = "/custom/path/to/repo";
    let repo = Repo::from(&repo_dir);
	let commit_args = CommitArgs::default();
    if let Ok(commits) = repo.list_commits(commit_args) {
		let stats = repo.commits_stats(&commits);
    }
}

pub fn commit_stats(&self, commit: CommitHash) -> Result<CommitDetail>

Extract details from a commit hash

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Repo

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

Formats the value using the given formatter.

impl Display for Repo

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

Formats the value using the given formatter.

impl<'a, T: ?Sized + AsRef<OsStr>> From<&'a T> for Repo

fn from(s: &'a T) -> Self

Converts to this type from the input type.