Skip to main content

CliOps

Struct CliOps 

Source
pub struct CliOps {
    pub repo_dir: PathBuf,
    pub notes_ref: String,
}
Expand description

Git operations implemented by shelling out to the git CLI.

Fields§

§repo_dir: PathBuf§notes_ref: String

Implementations§

Source§

impl CliOps

Source

pub fn new(repo_dir: PathBuf) -> Self

Source

pub fn with_notes_ref(self, notes_ref: String) -> Self

Trait Implementations§

Source§

impl GitOps for CliOps

Source§

fn diff(&self, commit: &str) -> Result<Vec<FileDiff>, GitError>

Get the diff for a single commit.
Source§

fn note_read(&self, commit: &str) -> Result<Option<String>, GitError>

Read a git note from the chronicle notes ref.
Source§

fn note_write(&self, commit: &str, content: &str) -> Result<(), GitError>

Write a git note to the chronicle notes ref (overwrites existing).
Source§

fn note_exists(&self, commit: &str) -> Result<bool, GitError>

Check if a note exists for a commit.
Source§

fn file_at_commit(&self, path: &Path, commit: &str) -> Result<String, GitError>

Read a file at a specific commit.
Source§

fn commit_info(&self, commit: &str) -> Result<CommitInfo, GitError>

Get commit metadata.
Source§

fn resolve_ref(&self, refspec: &str) -> Result<String, GitError>

Resolve a ref (branch name, HEAD, etc.) to a SHA.
Source§

fn config_get(&self, key: &str) -> Result<Option<String>, GitError>

Read a git config value.
Source§

fn config_set(&self, key: &str, value: &str) -> Result<(), GitError>

Set a git config value.
Source§

fn log_for_file(&self, path: &str) -> Result<Vec<String>, GitError>

List commit SHAs that touched a file (newest first), following renames.
Source§

fn list_annotated_commits(&self, limit: u32) -> Result<Vec<String>, GitError>

List commit SHAs that have chronicle notes (newest first), up to limit.

Auto Trait Implementations§

§

impl Freeze for CliOps

§

impl RefUnwindSafe for CliOps

§

impl Send for CliOps

§

impl Sync for CliOps

§

impl Unpin for CliOps

§

impl UnwindSafe for CliOps

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more