Skip to main content

Reference

Struct Reference 

Source
pub struct Reference;
Expand description

Reference operations — resolve a named ref to an object id.

Implementations§

Source§

impl Reference

Source

pub fn resolve(repo: &Repository, name: &str) -> Result<ObjectId>

Resolve a reference name (e.g., "HEAD", "refs/heads/main", "main") to its target object id.

Uses git rev-parse --verify <name>. Short names like "main" are resolved via git’s standard ref resolution rules.

Source

pub fn symbolic_target(repo: &Repository, name: &str) -> Result<Option<String>>

Return the symbolic target of a reference, if it is symbolic (e.g., "HEAD" → "refs/heads/main").

Uses git symbolic-ref -q <name>.

Source

pub fn list(repo: &Repository) -> Result<Vec<RefEntry>>

Every local branch, remote-tracking branch and tag, in one call.

MG.35. crate::Branch::list answers “what branches are there”; this answers “what refs are there, and where does each point” — the question magit’s refs buffer exists for. One for-each-ref rather than three walks plus an ahead/behind count per branch: git computes %(upstream:track) while it is already reading the ref, so the whole buffer costs a single invocation regardless of how many branches the repository has.

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> 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.