githash

Documentation

Overview

Package githash provides types for Git object identifiers.

Index

• Constants
• type Ref
  • func BranchRef(b string) Ref
  • func TagRef(t string) Ref
  • func (r Ref) Branch() string
  • func (r Ref) IsBranch() bool
  • func (r Ref) IsTag() bool
  • func (r Ref) IsValid() bool
  • func (r Ref) String() string
  • func (r Ref) Tag() string
• type SHA1
  • func ParseSHA1(s string) (SHA1, error)
  • func (h SHA1) Format(f fmt.State, c rune)
  • func (h SHA1) MarshalBinary() ([]byte, error)
  • func (h SHA1) MarshalText() ([]byte, error)
  • func (h SHA1) Short() string
  • func (h SHA1) String() string
  • func (h *SHA1) UnmarshalBinary(b []byte) error
  • func (h *SHA1) UnmarshalText(s []byte) error

Constants

const SHA1Size = 20

SHA1Size is the number of bytes in a SHA-1 hash.

Types

type Ref

type Ref string

A Ref is a Git reference to a commit.

const (
	// Head names the commit on which the changes in the working tree
	// are based.
	Head Ref = "HEAD"

	// FetchHead records the branch which was fetched from a remote
	// repository with the last git fetch invocation.
	FetchHead Ref = "FETCH_HEAD"
)

Top-level refs.

func BranchRef

func BranchRef(b string) Ref

BranchRef returns a ref for the given branch name.

func TagRef

func TagRef(t string) Ref

TagRef returns a ref for the given tag name.

func (Ref) Branch

func (r Ref) Branch() string

Branch returns the string after "refs/heads/" or an empty string if the ref does not start with "refs/heads/".

func (Ref) IsBranch

func (r Ref) IsBranch() bool

IsBranch reports whether r starts with "refs/heads/".

func (Ref) IsTag

func (r Ref) IsTag() bool

IsTag reports whether r starts with "refs/tags/".

func (Ref) IsValid

func (r Ref) IsValid() bool

IsValid reports whether r is a valid reference name. See https://git-scm.com/docs/git-check-ref-format for rules.

func (Ref) String

func (r Ref) String() string

String returns the ref as a string.

func (Ref) Tag

func (r Ref) Tag() string

Tag returns the string after "refs/tags/" or an empty string if the ref does not start with "refs/tags/".

type SHA1

type SHA1 [SHA1Size]byte

A SHA1 is the SHA-1 hash of a Git object.

func ParseSHA1

func ParseSHA1(s string) (SHA1, error)

ParseSHA1 parses a hex-encoded SHA-1 hash. It is the same as calling UnmarshalText on a new SHA1.

func (SHA1) Format

func (h SHA1) Format(f fmt.State, c rune)

Format implements the fmt.Formatter interface. Specifically, it ensures that %x does not double-hex-encode the data.

func (SHA1) MarshalBinary

func (h SHA1) MarshalBinary() ([]byte, error)

MarshalBinary returns the hash as a byte slice.

func (SHA1) MarshalText

func (h SHA1) MarshalText() ([]byte, error)

MarshalText returns the hex-encoded hash.

func (SHA1) Short

func (h SHA1) Short() string

Short returns the first 4 hex-encoded bytes of the hash.

func (SHA1) String

func (h SHA1) String() string

String returns the hex-encoded hash.

func (*SHA1) UnmarshalBinary

func (h *SHA1) UnmarshalBinary(b []byte) error

UnmarshalBinary copies the bytes from b into h. It returns an error if len(b) != len(*h).

func (*SHA1) UnmarshalText

func (h *SHA1) UnmarshalText(s []byte) error

UnmarshalText decodes a hex-encoded hash into h.