Struct Repository

Source
pub struct Repository { /* private fields */ }
Expand description

Represents the state associated with a Git repository.

Many other types in this crate are derived from methods in this struct.

Implementations§

Source§

impl Repository

Source

pub fn open(repo_uri: impl AsRef<Path>) -> Result<Self, Error>

Open a git repository given its exact URI.

§Errors
Examples found in repository?
examples/diff.rs (line 50)
49fn init_repository_or_exit(path_to_repo: &str) -> Repository {
50    match Repository::open(path_to_repo) {
51        Ok(repo) => repo,
52        Err(e) => {
53            println!("Failed to create repository: {e:?}");
54            std::process::exit(1);
55        }
56    }
57}
Source

pub fn discover(repo_uri: impl AsRef<Path>) -> Result<Self, Error>

Attempt to open a git repository at or above repo_uri in the file system.

Examples found in repository?
examples/browsing.rs (line 41)
33fn main() {
34    let repo_path = match env::args().nth(1) {
35        Some(path) => path,
36        None => {
37            print_usage();
38            return;
39        }
40    };
41    let repo = Repository::discover(repo_path).unwrap();
42    let now = Instant::now();
43    let head = repo.head().unwrap();
44    let root = repo.root_dir(head).unwrap();
45    print_directory(&root, &repo, 0);
46
47    let elapsed_millis = now.elapsed().as_millis();
48    println!("browse with print: {elapsed_millis} ms");
49}
Source

pub fn which_namespace(&self) -> Result<Option<Namespace>, Error>

What is the current namespace we’re browsing in.

Source

pub fn switch_namespace(&self, namespace: &RefString) -> Result<(), Error>

Switch to a namespace

Source

pub fn with_namespace<T, F>( &self, namespace: &RefString, f: F, ) -> Result<T, Error>
where F: FnOnce() -> Result<T, Error>,

Source

pub fn branches<G>(&self, pattern: G) -> Result<Branches<'_>, Error>
where G: Into<Glob<Branch>>,

Returns an iterator of branches that match pattern.

Source

pub fn branch_names<G>(&self, filter: G) -> Result<BranchNames<'_>, Error>
where G: Into<Glob<Branch>>,

Lists branch names with filter.

Source

pub fn tags(&self, pattern: &Glob<Tag>) -> Result<Tags<'_>, Error>

Returns an iterator of tags that match pattern.

Source

pub fn tag_names(&self, filter: &Glob<Tag>) -> Result<TagNames<'_>, Error>

Lists tag names in the local RefScope.

Source

pub fn categories( &self, pattern: &Glob<Qualified<'_>>, ) -> Result<Categories<'_>, Error>

Source

pub fn namespaces(&self, pattern: &Glob<Namespace>) -> Result<Namespaces, Error>

Returns an iterator of namespaces that match pattern.

Source

pub fn diff( &self, from: impl Revision, to: impl Revision, ) -> Result<Diff, Error>

Get the Diff between two commits.

Examples found in repository?
examples/diff.rs (line 35)
25fn main() {
26    let options = get_options_or_exit();
27    let repo = init_repository_or_exit(&options.path_to_repo);
28    let head_oid = match options.head_revision {
29        HeadRevision::Head => repo.head().unwrap(),
30        HeadRevision::Commit(id) => Oid::from_str(&id).unwrap(),
31    };
32    let base_oid = Oid::from_str(&options.base_revision).unwrap();
33    let now = Instant::now();
34    let elapsed_nanos = now.elapsed().as_nanos();
35    let diff = repo.diff(base_oid, head_oid).unwrap();
36    print_diff_summary(&diff, elapsed_nanos);
37}
Source

pub fn diff_commit(&self, commit: impl ToCommit) -> Result<Diff, Error>

Get the Diff of a commit.

If the commit has a parent, then it the diff will be a comparison between itself and that parent. Otherwise, the left hand side of the diff will pass nothing.

Source

pub fn diff_file<P: AsRef<Path>, R: Revision>( &self, path: &P, from: R, to: R, ) -> Result<FileDiff, Error>

Get the FileDiff between two revisions for a file at path.

If path is only a directory name, not a file, returns a FileDiff for any file under path.

Source

pub fn oid(&self, oid: &str) -> Result<Oid, Error>

Parse an Oid from the given string.

Source

pub fn root_dir<C: ToCommit>(&self, commit: C) -> Result<Directory, Error>

Returns a top level Directory without nested sub-directories.

To visit inside any nested sub-directories, call directory.get(&repo) on the sub-directory.

Examples found in repository?
examples/browsing.rs (line 44)
33fn main() {
34    let repo_path = match env::args().nth(1) {
35        Some(path) => path,
36        None => {
37            print_usage();
38            return;
39        }
40    };
41    let repo = Repository::discover(repo_path).unwrap();
42    let now = Instant::now();
43    let head = repo.head().unwrap();
44    let root = repo.root_dir(head).unwrap();
45    print_directory(&root, &repo, 0);
46
47    let elapsed_millis = now.elapsed().as_millis();
48    println!("browse with print: {elapsed_millis} ms");
49}
Source

pub fn directory<C: ToCommit, P: AsRef<Path>>( &self, commit: C, path: &P, ) -> Result<Directory, Error>

Returns a Directory for path in commit.

Source

pub fn file<C: ToCommit, P: AsRef<Path>>( &self, commit: C, path: &P, ) -> Result<File, Error>

Returns a File for path in commit.

Source

pub fn tree<C: ToCommit, P: AsRef<Path>>( &self, commit: C, path: &P, ) -> Result<Tree, Error>

Returns a Tree for path in commit.

Source

pub fn blob<'a, C: ToCommit, P: AsRef<Path>>( &'a self, commit: C, path: &P, ) -> Result<Blob<BlobRef<'a>>, Error>

Returns a Blob for path in commit.

Source

pub fn blob_ref(&self, oid: Oid) -> Result<BlobRef<'_>, Error>

Source

pub fn last_commit<P, C>( &self, path: &P, rev: C, ) -> Result<Option<Commit>, Error>
where P: AsRef<Path>, C: ToCommit,

Returns the last commit, if exists, for a path in the history of rev.

Source

pub fn commit<R: Revision>(&self, rev: R) -> Result<Commit, Error>

Returns a commit for rev, if it exists.

Source

pub fn stats(&self) -> Result<Stats, Error>

Gets the Stats of this repository starting from the HEAD (see Repository::head) of the repository.

Source

pub fn stats_from<R>(&self, rev: &R) -> Result<Stats, Error>
where R: Revision,

Gets the Stats of this repository starting from the given rev.

Source

pub fn get_commit_file<P, R>( &self, rev: &R, path: &P, ) -> Result<FileContent<'_>, Error>
where P: AsRef<Path>, R: Revision,

Retrieves the file with path in this commit.

Source

pub fn head(&self) -> Result<Oid, Error>

Returns the Oid of the current HEAD.

Examples found in repository?
examples/browsing.rs (line 43)
33fn main() {
34    let repo_path = match env::args().nth(1) {
35        Some(path) => path,
36        None => {
37            print_usage();
38            return;
39        }
40    };
41    let repo = Repository::discover(repo_path).unwrap();
42    let now = Instant::now();
43    let head = repo.head().unwrap();
44    let root = repo.root_dir(head).unwrap();
45    print_directory(&root, &repo, 0);
46
47    let elapsed_millis = now.elapsed().as_millis();
48    println!("browse with print: {elapsed_millis} ms");
49}
More examples
Hide additional examples
examples/diff.rs (line 29)
25fn main() {
26    let options = get_options_or_exit();
27    let repo = init_repository_or_exit(&options.path_to_repo);
28    let head_oid = match options.head_revision {
29        HeadRevision::Head => repo.head().unwrap(),
30        HeadRevision::Commit(id) => Oid::from_str(&id).unwrap(),
31    };
32    let base_oid = Oid::from_str(&options.base_revision).unwrap();
33    let now = Instant::now();
34    let elapsed_nanos = now.elapsed().as_nanos();
35    let diff = repo.diff(base_oid, head_oid).unwrap();
36    print_diff_summary(&diff, elapsed_nanos);
37}
Source

pub fn extract_signature( &self, commit: impl ToCommit, field: Option<&str>, ) -> Result<Option<Signature>, Error>

Extract the signature from a commit

§Arguments

field - the name of the header field containing the signature block; pass None to extract the default ‘gpgsig’

Source

pub fn history<C: ToCommit>(&self, head: C) -> Result<History<'_>, Error>

Returns the history with the head commit.

Source

pub fn revision_branches( &self, rev: impl Revision, glob: Glob<Branch>, ) -> Result<Vec<Branch>, Error>

Lists branches that are reachable from rev.

Trait Implementations§

Source§

impl Debug for Repository

Source§

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

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

impl From<Repository> for Repository

Source§

fn from(repo: Repository) -> Self

Converts to this type from the input type.

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> 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, 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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T