Struct Repository 

pub struct Repository { /* private fields */ }

Implementations

impl Repository

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

Errors

Returns an error if HEAD cannot be resolved or has no parent.

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

Errors

Returns an error if the commit cannot be created.

impl Repository

pub fn changed_files( &self, base: Option<&str>, head: &str, ) -> Result<Vec<FileChange>>

Errors

Returns GitError::RefNotFound if either base or head cannot be resolved.

pub fn uncommitted_changes(&self) -> Result<Vec<FileChange>>

Errors

Returns GitError::RefNotFound if HEAD cannot be resolved.

pub fn changed_files_from_head(&self, base: &str) -> Result<Vec<FileChange>>

Errors

Returns GitError::RefNotFound if the base reference cannot be resolved.

impl Repository

pub fn delete_file(&self, path: &Path) -> Result<()>

Errors

Returns GitError::FileDelete if the file cannot be deleted.

pub fn delete_files(&self, paths: &[&Path]) -> Result<()>

Errors

Returns GitError::FileDelete if any file cannot be deleted.

impl Repository

pub fn remote_url(&self) -> Result<Option<String>>

Errors

Returns an error if the remote lookup fails.

impl Repository

pub fn stage_files(&self, paths: &[&Path]) -> Result<()>

Errors

Returns an error if staging any of the files fails.

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

Errors

Returns an error if the staging operation fails.

impl Repository

pub fn current_branch(&self) -> Result<String>

Errors

Returns GitError::DetachedHead if HEAD is not on a branch.

pub fn is_working_tree_clean(&self) -> Result<bool>

Errors

Returns an error if the git status operation fails.

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

Errors

Returns GitError::DirtyWorkingTree if there are uncommitted changes.

impl Repository

pub fn delete_tag(&self, name: &str) -> Result<bool>

Returns Ok(true) if the tag was deleted, Ok(false) if the tag was not found.

Errors

Returns an error if the delete operation fails for reasons other than “not found”.

pub fn create_tag(&self, name: &str, message: &str) -> Result<TagInfo>

Errors

Returns an error if the tag cannot be created or already exists.

impl Repository

pub fn open(path: &Path) -> Result<Self>

Errors

Returns GitError::NotARepository if the path is not inside a git repository.

pub fn root(&self) -> &Path