Struct Repository

pub struct Repository { /* private fields */ }

A local git repository

Implementations

impl Repository

pub fn new<P: AsRef<Path>>(p: P) -> Repository

Create a Repository struct from a pre-existing local git repository

pub fn clone<P: AsRef<Path>>(url: GitUrl, p: P) -> Result<Repository>

Clone a remote git repository locally

pub fn init<P: AsRef<Path>>(p: P) -> Result<Repository>

Initialise a given folder as a git repository

pub fn create_local_branch(&self, branch_name: &BranchName) -> Result<()>

Create and checkout a new local branch

pub fn switch_branch(&self, branch_name: &BranchName) -> Result<()>

Checkout the specified branch

pub fn add(&self, pathspecs: Vec<&str>) -> Result<()>

Add file contents to the index

pub fn remove(&self, pathspecs: Vec<&str>, force: bool) -> Result<()>

Remove file contents from the index

pub fn commit_all(&self, message: &str) -> Result<()>

Commit all staged files

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

Push the curent branch to its associated remote

pub fn push_to_upstream( &self, upstream: &str, upstream_branch: &BranchName, ) -> Result<()>

Push the curent branch to its associated remote, specifying the upstream branch

pub fn add_remote(&self, name: &str, url: &GitUrl) -> Result<()>

Add a new remote

pub fn fetch_remote(&self, remote: &str) -> Result<()>

Fetch a remote

pub fn create_branch_from_startpoint( &self, branch_name: &BranchName, startpoint: &str, ) -> Result<()>

Create a new branch from a start point, such as another local or remote branch

pub fn list_branches(&self) -> Result<Vec<String>>

List local branches

pub fn list_added(&self) -> Result<Vec<String>>

List files added to staging area

pub fn list_modified(&self) -> Result<Vec<String>>

List all modified files

pub fn list_untracked(&self) -> Result<Vec<String>>

List all untracked files

pub fn list_tracked(&self) -> Result<Vec<String>>

List tracked files

pub fn show_remote_uri(&self, remote_name: &str) -> Result<String>

List all the remote URI for name

pub fn list_remotes(&self) -> Result<Vec<String>>

List all the remote URI for name

pub fn get_hash(&self, short: bool) -> Result<String>

Obtains commit hash of the current HEAD.

pub fn cmd<I, S>(&self, args: I) -> Result<()>

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Execute user defined command

pub fn cmd_out<I, S>(&self, args: I) -> Result<Vec<String>>

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Execute user defined command and return its output