Class: Git::Repository::Branching::HeadState Private

Inherits:

Data

• Object
• Data
• Git::Repository::Branching::HeadState

Defined in:

lib/git/repository/branching.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Represents the state of HEAD in a repository

Instance Attribute Summary

• #name ⇒ String readonly

  The branch name, or 'HEAD' when detached.

• #state ⇒ Symbol readonly

  One of :active, :unborn, or :detached.

Instance Attribute Details

#name ⇒ String (readonly)

Returns the branch name, or 'HEAD' when detached.

Returns:

• (String) —

  the branch name, or 'HEAD' when detached

# File 'lib/git/repository/branching.rb', line 40

HeadState = Data.define(:state, :name)

#state ⇒ Symbol (readonly)

Returns one of :active, :unborn, or :detached.

Returns:

• (Symbol) —

  one of :active, :unborn, or :detached

# File 'lib/git/repository/branching.rb', line 40

HeadState = Data.define(:state, :name)