Struct CodexRepository

pub struct CodexRepository { /* private fields */ }

A CodexRepository is a Git Repository that is managed by this crate. It tracks whether the repository needs to be committed or pushed.

Implementations

impl CodexRepository

pub fn new(repo: Repository, config: &CodexRepoConfig) -> Self

initialise the repository based on the CodexRepoConfig.

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

fetches data from the remote and merges if necessary

pub fn commit_and_push(&mut self) -> Result<()>

commit_and_push commits changes and pushes them

pub fn commit(&mut self) -> NullResult

commit commits any changes to the local repository.

pub fn add(&mut self, path: PathBuf) -> NullResult

add adds a file to the index

pub fn push(&mut self, force: bool) -> NullResult

push tries to push any local changes to the remote.

Trait Implementations

impl Debug for CodexRepository

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

Formats the value using the given formatter.

impl Display for CodexRepository

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

Formats the value using the given formatter.

impl Drop for CodexRepository

fn drop(&mut self)

Executes the destructor for this type.