Struct CommitRef

pub struct CommitRef { /* private fields */ }

Bookmark or tag name with metadata.

Implementations

impl CommitRef

pub fn local<'a>( name: impl Into<String>, target: RefTarget, remote_refs: impl IntoIterator<Item = &'a RemoteRef>, ) -> Rc<Self>

Creates local ref representation which might track some of the remote_refs.

pub fn local_only(name: impl Into<String>, target: RefTarget) -> Rc<Self>

Creates local ref representation which doesn’t track any remote refs.

pub fn remote( name: impl Into<String>, remote_name: impl Into<String>, remote_ref: RemoteRef, local_target: &RefTarget, ) -> Rc<Self>

Creates remote ref representation which might be tracked by a local ref pointing to the local_target.

pub fn remote_only( name: impl Into<String>, remote_name: impl Into<String>, target: RefTarget, ) -> Rc<Self>

Creates remote ref representation which isn’t tracked by a local ref.

pub fn name(&self) -> &str

Local name.

pub fn remote_name(&self) -> Option<&str>

Remote name if this is a remote or Git-tracking ref.

pub fn target(&self) -> &RefTarget

Target commit ids.

pub fn is_local(&self) -> bool

Returns true if this is a local ref.

pub fn is_remote(&self) -> bool

Returns true if this is a remote ref.

pub fn is_absent(&self) -> bool

Returns true if this ref points to no commit.

pub fn is_present(&self) -> bool

Returns true if this ref points to any commit.

pub fn has_conflict(&self) -> bool

Whether the ref target has conflicts.

pub fn is_tracked(&self) -> bool

Returns true if this ref is tracked by a local ref. The local ref might have been deleted (but not pushed yet.)

pub fn is_tracking_present(&self) -> bool

Returns true if this ref is tracked by a local ref, and if the local ref is present.

Trait Implementations

impl Debug for CommitRef

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

Formats the value using the given formatter.

impl Serialize for CommitRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.