Struct Repo

pub struct Repo { /* private fields */ }

Structure properties.

Implementations

impl Repo

Repo functions.

pub fn init<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Creates a new --bare repository in the specified folder.

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Opens an existing repository.

pub fn path(&self) -> &Path

Returns repository path.

pub fn len(&self) -> usize

Returns the number of all keys.

pub fn has_commits(&self) -> bool

Returns true if repository has no commits.

pub fn has_branches(&self) -> bool

Returns true if at least one branch exists.

pub fn has_keys(&self) -> bool

Returns true if at least one key exists.

pub fn has_branch(&self, name: &str) -> bool

Returns true if the provided branch exists.

pub fn has_key(&self, name: &str) -> bool

Returns true if the key exists.

pub fn branches(&self) -> Vec<String>

Returns working branch name.

pub fn keys(&self) -> Vec<String>

List all available keys.

pub fn branch(&self) -> Option<String>

Returns working branch name.

pub fn key(&self, name: &str) -> Option<Vec<u8>>

Retrieves key content.

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

Ensures new working branch. There must be at least one commit in the repository for this method to work other wise the error is thrown.

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

Removes working branch. Note that the current branch can not be removed and you have to first switch to a new branch.

pub fn insert_key(&mut self, name: &str, value: &[u8]) -> Result<(), Error>

Stages key for commit.

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

Stages key for removal.

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

Stages key for removal.

pub fn changed(&self) -> bool

Returns true if any key has been changed.

pub fn key_changed(&self, name: &str) -> bool

Returns true if the key content has been changed.

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

Reset all keys.

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

Remove all keys.

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

Commit data.