Struct CodexRepository

Source
pub struct CodexRepository { /* private fields */ }
Expand description

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

Implementations§

Source§

impl CodexRepository

Source

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

initialise the repository based on the CodexRepoConfig.

Source

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

fetches data from the remote and merges if necessary

Source

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

commit_and_push commits changes and pushes them

Source

pub fn commit(&mut self) -> NullResult

commit commits any changes to the local repository.

Source

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

add adds a file to the index

Source

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

push tries to push any local changes to the remote.

Trait Implementations§

Source§

impl Debug for CodexRepository

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for CodexRepository

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for CodexRepository

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,