Struct Repo

pub struct Repo(/* private fields */);

Implementations

impl Repo

pub fn open(path: impl AsRef<Path>) -> Result<Self, GitError>

Attempt to open an already-existing repository at path.

The path can point to either a normal or bare repository.

pub fn discover(path: impl AsRef<Path>) -> Result<Self, GitError>

Attempt to open an already-existing repository at or above path.

This starts at path and looks up the filesystem hierarchy until it finds a repository.

pub fn commits(&self) -> Result<Commits<'_>, GitError>

Returns an iterator that produces all commits in the repo.

See .commits_ext() to be able to specify the order.

Examples found in repository

examples/example.rs (line 7)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let path = std::env::args().nth(1).unwrap_or_else(|| String::from("."));
    let repo = git_commits::open(&path)?;

    for commit in repo.commits()? {
        let commit = commit?;

        let msg = commit.message_lossy();
        let first_line = msg.trim().lines().next().unwrap_or_default();

        let committer = commit.committer();
        let author = commit.author();

        println!();
        println!("SHA:     {}", commit.sha());
        println!("Time:    {}", committer.time_local().unwrap()); // same as `commit.time_local()`
        println!("Author:  {}", author.name_lossy());
        println!("Message: {first_line}");
        println!();

        for change in commit.changes()? {
            let change = change?;

            // The following `match` can be simplified, by simply doing:
            // println!("  {}", change);

            match change {
                Change::Added(change) => {
                    println!(
                        "  {} {} ({} bytes)",
                        change.kind().letter(),
                        change.path().display(),
                        change.size(),
                    );
                }
                Change::Modified(change) => {
                    println!(
                        "  {} {} ({} -> {} bytes)",
                        change.kind().letter(),
                        change.path().display(),
                        change.old_size(),
                        change.new_size(),
                    );
                }
                Change::Deleted(change) => {
                    println!(
                        "  {} {} ({} bytes)",
                        change.kind().letter(),
                        change.path().display(),
                        change.size(),
                    );
                }
                Change::Renamed(change) => {
                    println!(
                        "  {} {} -> {} ({} bytes)",
                        change.kind().letter(),
                        change.old_path().display(),
                        change.new_path().display(),
                        change.size(),
                    );
                }
            }
        }
    }

    Ok(())
}

pub fn commits_ext(&self, sort: Sort) -> Result<Commits<'_>, GitError>

Returns an iterator that produces all commits in the repo.