Struct branchless::git::ResolvedReferenceInfo[−][src]

pub struct ResolvedReferenceInfo<'a> {
    pub oid: Option<NonZeroOid>,
    pub reference_name: Option<Cow<'a, OsStr>>,
}

Expand description

A snapshot of information about a certain reference. Updates to the reference after this value is obtained are not reflected.

HEAD is typically a symbolic reference, which means that it’s a reference that points to another reference. Usually, the other reference is a branch. In this way, you can check out a branch and move the branch (e.g. by committing) and HEAD is also effectively updated (you can traverse the pointed-to reference and get the current commit OID).

There are a couple of interesting edge cases to worry about:

HEAD is detached. This means that it’s pointing directly to a commit and is not a symbolic reference for the time being. This is uncommon in normal Git usage, but very common in git-branchless usage.
HEAD is unborn. This means that it doesn’t even exist yet. This happens when a repository has been freshly initialized, but no commits have been made, for example.

Fields

oid: Option<NonZeroOid>

The OID of the commit that HEAD points to. If HEAD is unborn, then this is None.

reference_name: Option<Cow<'a, OsStr>>

The name of the reference that HEAD points to symbolically. If HEAD is detached, then this is None.

Struct branchless::git::ResolvedReferenceInfo[−][src]

Fields

Implementations

impl<'a> ResolvedReferenceInfo<'a>

pub fn get_branch_name(&self) -> Result<Option<OsString>>

Trait Implementations

impl<'a> Debug for ResolvedReferenceInfo<'a>

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

impl<'a> PartialEq<ResolvedReferenceInfo<'a>> for ResolvedReferenceInfo<'a>

fn eq(&self, other: &ResolvedReferenceInfo<'a>) -> bool

fn ne(&self, other: &ResolvedReferenceInfo<'a>) -> bool

impl<'a> Eq for ResolvedReferenceInfo<'a>

impl<'a> StructuralEq for ResolvedReferenceInfo<'a>

impl<'a> StructuralPartialEq for ResolvedReferenceInfo<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for ResolvedReferenceInfo<'a>

impl<'a> Send for ResolvedReferenceInfo<'a>

impl<'a> Sync for ResolvedReferenceInfo<'a>

impl<'a> Unpin for ResolvedReferenceInfo<'a>

impl<'a> UnwindSafe for ResolvedReferenceInfo<'a>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

impl<T> AsAny for T where T: Any,

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

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

pub fn borrow(&self) -> &T

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

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

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

pub fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&'a self) -> FgColorDisplay<'a, C, Self> where C: Color,

fn bg<C>(&'a self) -> BgColorDisplay<'a, C, Self> where C: Color,

fn black(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white(&'a self) -> BgColorDisplay<'a, White, Self>

fn bright_black(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_purple(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_purple(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_cyan(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

fn on_bright_cyan(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

fn bright_white(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

fn on_bright_white(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

fn bold(&'a self) -> BoldDisplay<'a, Self>

fn dimmed(&'a self) -> DimDisplay<'a, Self>

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

impl<T> AsAny for T where
T: Any,

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

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

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

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

fn fg<C>(&'a self) -> FgColorDisplay<'a, C, Self> where
C: Color,

fn bg<C>(&'a self) -> BgColorDisplay<'a, C, Self> where
C: Color,

fn color<Color>(&'a self, color: Color) -> FgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

fn on_color<Color>(&'a self, color: Color) -> BgDynColorDisplay<'a, Color, Self> where
Color: DynColor,

fn on_truecolor(
&'a self,
r: u8,
g: u8,
b: u8
) -> BgDynColorDisplay<'a, Rgb, Self>

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn wrap_with<U, F>(self, f: F) -> U where
F: FnOnce(Self) -> U,

fn with<F>(self, f: F) -> Self where
F: FnOnce(&mut Self),

fn try_with<E, F>(self, f: F) -> Result<Self, E> where
F: FnOnce(&mut Self) -> Result<(), E>,

fn with_if<F>(self, condition: bool, f: F) -> Self where
F: FnOnce(&mut Self),

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