reference

Documentation

Index

• Constants
• Variables
• func DockerRefFromReference(ref Reference) reference.Named
• type ID
  • func IDFromDigest(d digest.Digest) ID
  • func IDFromString(id string) (ID, error)
  • func (i ID) String() string
• type IdOrLocalTag
• type IdOrRemoteTag
• type IdOrTag
• type IdOrTagConstraint
• type Local
  • func LocalFromName(name Name) Local[LocalTag]
  • func NewLocal[T IdOrLocalTag](name Name, idOrTag T) Local[T]
  • func (r Local) GetIdOrTag() T
  • func (r Local) IdOrTag() string
  • func (r Local) Name() Name
  • func (r Local) String() string
• type LocalRef
  • func LocalRefFromString(rawRef string) (LocalRef, error)
• type LocalTag
  • func LocalTagFromString(rawTag string) (LocalTag, error)
  • func LocalTagFromTag(tag Tag) LocalTag
  • func (t LocalTag) String() string
  • func (t LocalTag) Tag() string
• type Name
  • func NameFromNamed(named reference.Named) Name
  • func NameFromString(name string) (Name, error)
  • func (n Name) String() string
• type Reference
• type Relative
  • func RelativeFromReferenceAndOffset(ref Reference, offset uint) Relative
  • func RelativeFromString(ref string) (Relative, error)
  • func (r Relative) Base() Reference
  • func (r Relative) Offset() uint
  • func (r Relative) String() string
• type Remote
  • func NewRemote[T IdOrRemoteTag](name Name, idOrTag T) Remote[T]
  • func RemoteFromName(name Name) Remote[RemoteTag]
  • func (r Remote) GetIdOrTag() T
  • func (r Remote) IdOrTag() string
  • func (r Remote) Name() Name
  • func (r Remote) String() string
• type RemoteRef
  • func RemoteRefFromString(rawRef string) (RemoteRef, error)
• type RemoteTag
  • func RemoteTagFromString(rawTag string) (RemoteTag, error)
  • func RemoteTagFromTag(tag Tag) RemoteTag
  • func (t RemoteTag) String() string
  • func (t RemoteTag) Tag() string
• type Tag
• type TagConstraint

Constants

const (
	// HEAD reserved tag
	Head = "HEAD"
	// REBASE_HEAD reserved tag
	RebaseHead = "REBASE_HEAD"

	Latest = "latest"

	IdPrefix  = "@sha256:"
	TagPrefix = ":"
)

Variables

var (
	ErrNotAName            = errors.New("not a name")
	ErrNameContainsTagOrID = errors.New("name contains tag or id")
)

var (
	ErrIDInvalidFormat = errors.New("invalid id format")
	ErrTagIsReserved   = errors.New("tag is reserved")

	HeadTag       = LocalTagFromTag(tag{TagPrefix + Head})
	RebaseHeadTag = LocalTagFromTag(tag{TagPrefix + RebaseHead})
	LatestTag     = RemoteTagFromTag(tag{TagPrefix + Latest})
)

var (
	ErrInvalidOffsetFormat = errors.New("invalid offset format")
)

Functions

func DockerRefFromReference

func DockerRefFromReference(ref Reference) reference.Named

DockerRefFromReference returns a docker reference from the given repository reference.

Types

type ID

type ID struct {
	// contains filtered or unexported fields
}

ID defines the ID component of a repository reference.

func IDFromDigest

func IDFromDigest(d digest.Digest) ID

IDFromDigested returns an ID from the given digest.

func IDFromString

func IDFromString(id string) (ID, error)

IDFromString returns a new ID if the given string is a valid ID.

func (ID) String

func (i ID) String() string

String implements fmt.Stringer.

type IdOrLocalTag

type IdOrLocalTag interface {
	ID | LocalTag
	fmt.Stringer
}

type IdOrRemoteTag

type IdOrRemoteTag interface {
	ID | RemoteTag
	fmt.Stringer
}

type IdOrTag

type IdOrTag interface {
	IdOrTag() string
}

type IdOrTagConstraint

type IdOrTagConstraint interface {
	ID | TagConstraint
	fmt.Stringer
}

IdOrTagConstraint is either an ID or a Tag.

type Local

type Local[T IdOrLocalTag] struct {
	// contains filtered or unexported fields
}

Local defines a concrete local reference with either an ID or a local tag.

func LocalFromName

func LocalFromName(name Name) Local[LocalTag]

LocalFromName returns a new Local reference with the given name and a Head tag.

func NewLocal

func NewLocal[T IdOrLocalTag](name Name, idOrTag T) Local[T]

NewLocal returns a new Local reference with the given name and ID or Tag.

func (Local) GetIdOrTag

func (r Local) GetIdOrTag() T

func (Local) IdOrTag

func (r Local) IdOrTag() string

func (Local) Name

func (r Local) Name() Name

func (Local) String

func (r Local) String() string

type LocalRef

type LocalRef interface {
	Reference
	// contains filtered or unexported methods
}

LocalRef defines a local repository reference.

func LocalRefFromString

func LocalRefFromString(rawRef string) (LocalRef, error)

type LocalTag

type LocalTag struct {
	// contains filtered or unexported fields
}

LocalTag defines a tag for local reference. Any docker tag is a valid local tag.

func LocalTagFromString

func LocalTagFromString(rawTag string) (LocalTag, error)

LocalTagFromString creates a new LocalTag after validating the given tag.

func LocalTagFromTag

func LocalTagFromTag(tag Tag) LocalTag

LocalTagFromTagged creates a new LocalTag from the given Tagged reference.

func (LocalTag) String

func (t LocalTag) String() string

String implements fmt.Stringer.

func (LocalTag) Tag

func (t LocalTag) Tag() string

Tag implements reference.Tagged

type Name

type Name struct {
	// contains filtered or unexported fields
}

Name define the name component of a Reference.

func NameFromNamed

func NameFromNamed(named reference.Named) Name

NameFromNamed returns a Name object from the given named reference.

func NameFromString

func NameFromString(name string) (Name, error)

Name returns a Name object from the given string after ensuring it is a valid name. An error is returned if the string is invalid or it contains a tag, an ID.

func (Name) String

func (n Name) String() string

String implements fmt.Stringer

type Reference

type Reference interface {
	String() string
	Name() Name
	IdOrTag
}

Reference defines a repository reference. A reference composed of a repository name and an ID or a Tag.

NAME[:TAG | @sha256:ID]

type Relative

type Relative struct {
	// contains filtered or unexported fields
}

Relative defines a relative reference. It is made of a base and an offset. Base is the reference on which the offset must be applied to get an absolute reference.

func RelativeFromReferenceAndOffset

func RelativeFromReferenceAndOffset(ref Reference, offset uint) Relative

RelativeFromReferenceAndOffset returns a new Relative reference base on the given reference and offset.

func RelativeFromString

func RelativeFromString(ref string) (Relative, error)

RelativeFromString parses the given string and returns relative reference after validating and normalizing it. An error is returned if the reference is invalid.

func (Relative) Base

func (r Relative) Base() Reference

Base returns the base of the relative reference

func (Relative) Offset

func (r Relative) Offset() uint

Offset returns the offset part of the relative reference.

func (Relative) String

func (r Relative) String() string

String implements fmt.Stringer.

type Remote

type Remote[T IdOrRemoteTag] struct {
	// contains filtered or unexported fields
}

Remote define a concrete remote reference with either an ID or a remote tag.

func NewRemote

func NewRemote[T IdOrRemoteTag](name Name, idOrTag T) Remote[T]

NewRemote returns a new Remote reference with the given name and tag.

func RemoteFromName

func RemoteFromName(name Name) Remote[RemoteTag]

RemoteFromName returns a new Remote reference with the given name and a Latest tag.

func (Remote) GetIdOrTag

func (r Remote) GetIdOrTag() T

func (Remote) IdOrTag

func (r Remote) IdOrTag() string

func (Remote) Name

func (r Remote) Name() Name

func (Remote) String

func (r Remote) String() string

type RemoteRef

type RemoteRef interface {
	Reference
	// contains filtered or unexported methods
}

func RemoteRefFromString

func RemoteRefFromString(rawRef string) (RemoteRef, error)

type RemoteTag

type RemoteTag struct {
	// contains filtered or unexported fields
}

RemoteTag defines a tag for remote reference. Remote tag can't contains reserved tag such as HEAD, REBASE_HEAD, etc.

func RemoteTagFromString

func RemoteTagFromString(rawTag string) (RemoteTag, error)

RemoteTagFromString creates a new RemoteTag after validating the given tag.

func RemoteTagFromTag

func RemoteTagFromTag(tag Tag) RemoteTag

RemoteTagFromTag creates a new RemoteTag from the given Tagged reference. This function panic if the given tag is a reserved tag.

func (RemoteTag) String

func (t RemoteTag) String() string

String implements fmt.Stringer.

func (RemoteTag) Tag

func (t RemoteTag) Tag() string

Tag implements reference.Tagged

type Tag

type Tag interface {
	Tag() string
}

Tag define objects with a tag.

type TagConstraint

type TagConstraint interface {
	LocalTag | RemoteTag
}

TagConstraint defines either a LocalTag or a RemoteTag.