Struct NotesRef 

pub struct NotesRef(/* private fields */);

Full ref name for a Git notes namespace (refs/notes/…).

Implementations

impl NotesRef

pub fn commits() -> Self

Default notes ref (refs/notes/commits).

pub fn from_full(full: &str) -> Result<Self>

Parse a full ref name that must live under refs/notes/.

Used for GIT_NOTES_REF, core.notesRef, and other configured refs (not --ref, which uses Self::parse).

Errors

Returns Error::InvalidNotesRef when full is not prefixed with refs/notes/ or is not a valid ref name (env/config values are not trimmed or otherwise normalized).

pub fn parse(short_or_full: &str) -> Self

Parse a short or full notes ref the same way Git’s --ref flag does: name and notes/name both become refs/notes/name; a name already under refs/notes/ is kept.

pub fn as_str(&self) -> &str

Borrow the canonical ref string.

Trait Implementations

impl Clone for NotesRef

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NotesRef

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

Formats the value using the given formatter.

impl Display for NotesRef

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

Formats the value using the given formatter.

impl Eq for NotesRef

impl Hash for NotesRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NotesRef

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NotesRef