Repo

Struct Repo 

Source
pub struct Repo { /* private fields */ }

Implementations§

Source§

impl Repo

Source

pub const fn inner(&self) -> &Repository

Source

pub fn local_path(&self) -> PathBuf

Returns the path to the local repo.

§Panics

Should never happen

Source

pub fn local_path_str(&self) -> String

Returns the path to the local repo as string.

§Panics

Should never happen

Source

pub fn sha(&self) -> Result<Option<String>, Error>

Returns the SHA of the currently checked-out commit, if any.

§Errors

If some git-related magic goes south, or there is no commit.

Source

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

Returns the local name of the currently checked-out branch, if any.

§Errors

If some git-related magic goes south, or the branch name is not valid UTF-8.

Source

pub fn tag(&self) -> Result<Option<String>, Error>

Returns the name of the currently checked-out tag, if any tag points to the current HEAD.

§Errors

If some git-related magic goes south, or the tag name is not valid UTF-8.

Source

pub fn remote_tracking_branch(&self) -> Result<Option<String>, Error>

The local name of the remote tracking branch.

§Errors

If some git-related magic goes south, or the remote name is not valid UTF-8.

Source

pub fn remote_name(&self) -> Result<Option<String>, Error>

Local name of the main remote.

§Errors

If some git-related magic goes south, or the reomte name is not valid UTF-8.

Source

pub fn remote_clone_url(&self) -> Result<Option<String>, Error>

Returns the clone URL of the main remote, if there is any.

§Errors

If some git-related magic goes south.

Source

pub fn version(&self) -> Result<String, Error>

Returns the version of the current state of the repo. This is basically the result of “git describe –tags –all <and-some-more…>”.

§Errors

If some git-related magic goes south.

Source

pub fn commit_date(&self, date_format: &str) -> Result<String, Error>

Returns the commit-time (not author-time) of the last commit in the currently checked out history (=> HEAD)

§Errors

If some git-related magic goes south.

Trait Implementations§

Source§

impl TryFrom<Option<&Path>> for Repo

Source§

type Error = Error

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

fn try_from(repo_root: Option<&Path>) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<Option<&str>> for Repo

Source§

type Error = Error

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

fn try_from(repo_root: Option<&str>) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl Freeze for Repo

§

impl RefUnwindSafe for Repo

§

impl Send for Repo

§

impl !Sync for Repo

§

impl Unpin for Repo

§

impl UnwindSafe for Repo

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> 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
Source§

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