Struct mhgit::Repository

pub struct Repository { /* fields omitted */ }

A handle to a git repository.

By creating with at the repository may be somewhere other than in current working directory.

use mhgit::Repository;
Repository::at("/home/mh/awesomeness")?
           .init()?
           .add()?
           .commit("Initial commit")?;

Implementations

impl Repository

pub fn new() -> Repository

Get a repository in the current directory.

use mhgit::Repository;
let status = Repository::new()
                        .status()?;

pub fn at<P: AsRef<Path>>(path: P) -> Result<Repository, Error>

Get a repository at the given location.

use mhgit::Repository;
Repository::at("/home/mh/awesomeness")?
           .init()?;

pub fn is_init(&self) -> bool

Return true if the repository is initialized.

pub fn gitout(&mut self, val: GitOut) -> &mut Repository

Configure if the output of git commands run in this repo should be piped or printed to screen.

Piping is default.

use mhgit::Repository;
use mhgit::GitOut::Print;
Repository::new()
    .gitout(Print)
    .status()?;

pub fn add(&mut self) -> Result<&mut Self, Error>

Run git add in the repository.

The command is called with the --all option. To call git add with different options use AddOptions.

pub fn commit(&mut self, msg: &str) -> Result<&mut Self, Error>

Run git commit in the repository, with the given commit message.

The command is called with --allow-empty, avoiding errors if no changes were added since last commit. To call git commit with different options use CommitOptions.

pub fn fetch(&mut self) -> Result<&mut Self, Error>

Run git fetch in the repository.

The command is called with --all

pub fn init(&mut self) -> Result<&mut Self, Error>

Run git init, initializing the repository.

pub fn notes(&mut self, msg: &str) -> Result<&mut Self, Error>

Run git notes add, adding a note to HEAD.

To call git notes with different optinos use NotesOptions.

pub fn pull(&mut self) -> Result<&mut Self, Error>

Run git pull without specifying remote or refs.

To call git pull with different options use PullOptions.

pub fn push(&mut self) -> Result<&mut Self, Error>

Run git push without specifying remote or refs.

To call git push with different options use PushOptions.

pub fn remote(&mut self, name: &str, url: &str) -> Result<&mut Self, Error>

Run git remote add in the repository.

This adds a single remote to the repository. To call git remote with different options use RemoteOptions.

pub fn status(&self) -> Result<Status, Error>

Run git status parsing the status into idiomatic Rust type.

The status information is returned in a Status.

pub fn stash(&mut self) -> Result<&mut Self, Error>

Run git stash in the repository.

The command is run without ony options.

pub fn tag(&mut self, tagname: &str) -> Result<&mut Self, Error>

Run git tag, creating a new tag object.

To call git tag with different options use TagOptions.

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.

impl Default for Repository

fn default() -> Repository

Returns the "default value" for a type.

impl Eq for Repository

impl Hash for Repository

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Repository> for Repository

fn eq(&self, other: &Repository) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Repository) -> bool

This method tests for !=.

impl StructuralEq for Repository

impl StructuralPartialEq for Repository