reference

Documentation

Index

• Constants
• Variables
• type LocalRepository
  • func LocalFromNamedTagged(named Named, tagged Tagged) LocalRepository
  • func LocalFromRemote(remoteRef RemoteRepository) LocalRepository
  • func LocalFromString(localRef string) (LocalRepository, error)
  • func LocalHeadFromNamed(ref Named) LocalRepository
  • func LocalRebaseFromNamed(ref Named) LocalRepository
  • func (lr LocalRepository) Name() string
  • func (lr LocalRepository) String() string
  • func (lr LocalRepository) Tag() string
• type Name
  • func NameFromNamed(ref Named) Name
  • func NameFromString(name string) (Name, error)
  • func (n Name) Name() string
  • func (n Name) String() string
• type Named
• type NamedTagged
• type ParseError
  • func (e ParseError) Error() string
• type RemoteRepository
  • func RemoteFromNamedTagged(named Named, tagged Tagged) (RemoteRepository, error)
  • func RemoteFromString(remoteRef string) (RemoteRepository, error)
  • func RemoteLatestFromNamed(named Named) RemoteRepository
  • func (rr RemoteRepository) Name() string
  • func (rr RemoteRepository) String() string
  • func (rr RemoteRepository) Tag() string
• type Tag
  • func TagFromString(tag string) (Tag, error)
  • func TagFromTagged(tag Tagged) Tag
  • func (t Tag) String() string
  • func (t Tag) Tag() string
• type Tagged

Constants

const (
	Head       = "HEAD"
	RebaseHead = "REBASE_HEAD"
)

Variables

var (
	ErrNameInvalidFormat       = fmt.Errorf("invalid name format: %w", reference.ErrReferenceInvalidFormat)
	ErrNameContainsTagOrDigest = errors.New("name contain tag or digest")
)

var (
	HeadTag       = Tag{/* contains filtered or unexported fields */}
	RebaseHeadTag = Tag{/* contains filtered or unexported fields */}
	LatestTag     = Tag{/* contains filtered or unexported fields */}
)

var (
	ErrRemoteRepoReferenceContainsReservedTag = errors.New("remote repository reference contains a reserved tag")
)

var (
	Latest = "latest"
)

Types

type LocalRepository

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

LocalRepository define an absolute reference to a local repository. Any named docker reference is a valid local repository reference. LocalRepository default tag is HEAD.

func LocalFromNamedTagged

func LocalFromNamedTagged(named Named, tagged Tagged) LocalRepository

LocalFromNamedTagged returns a new LocalRepositry with the given tag and name.

func LocalFromRemote

func LocalFromRemote(remoteRef RemoteRepository) LocalRepository

LocalFromRemote converts a RemoteRepository reference to a LocalRepository.

func LocalFromString

func LocalFromString(localRef string) (LocalRepository, error)

LocalFromString returns a local repository reference from the given string after validating and normalizing it. An error is returned if the reference is invalid.

func LocalHeadFromNamed

func LocalHeadFromNamed(ref Named) LocalRepository

LocalHeadFromNamed returns a new LocalRepository with "HEAD" tag and name of the given named.

func LocalRebaseFromNamed

func LocalRebaseFromNamed(ref Named) LocalRepository

LocalRebaseHeadFromNamed returns a new LocalRepository with "REBASE_HEAD" tag and name of the given named.

func (LocalRepository) Name

func (lr LocalRepository) Name() string

Name implements Named

func (LocalRepository) String

func (lr LocalRepository) String() string

String implements reference.Reference

func (LocalRepository) Tag

func (lr LocalRepository) Tag() string

Tag implements NamedTagged

type Name

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

Name define the name component of a repository reference.

func NameFromNamed

func NameFromNamed(ref Named) Name

func NameFromString

func NameFromString(name string) (Name, error)

NameFromString returns a Name from the given string after validating and normalizing it.

func (Name) Name

func (n Name) Name() string

Name implements Named

func (Name) String

func (n Name) String() string

String implements fmt.Stringer

type Named

type Named = reference.Named

Named is an object with a full name.

type NamedTagged

type NamedTagged = reference.NamedTagged

NamedTagged is an object including a name and tag.

type ParseError

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

func (ParseError) Error

func (e ParseError) Error() string

Error implements error

type RemoteRepository

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

RemoteRepository is a wrapper around docker reference ensuring the reference doesn't contain a HEAD tag or a relative reference.

func RemoteFromNamedTagged

func RemoteFromNamedTagged(named Named, tagged Tagged) (RemoteRepository, error)

RemoteFromNamedTagged returns a new RemoteReference with the given tag and name. An error is returned if tagged is HEAD.

func RemoteFromString

func RemoteFromString(remoteRef string) (RemoteRepository, error)

RemoteFromString returns a RemoteRepository reference from the given string after validating and normalizing it. An error is returned if the reference is invalid.

func RemoteLatestFromNamed

func RemoteLatestFromNamed(named Named) RemoteRepository

RemoteLatestFromNamed returns a new RemoteReference with a "latest" tag and name from the given Named.

func (RemoteRepository) Name

func (rr RemoteRepository) Name() string

Name implements Named

func (RemoteRepository) String

func (rr RemoteRepository) String() string

String implements reference.Reference

func (RemoteRepository) Tag

func (rr RemoteRepository) Tag() string

Tag implements NamedTagged

type Tag

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

Tag define the tag component of a repository reference.

func TagFromString

func TagFromString(tag string) (Tag, error)

NameFromString returns a Tag from the given string after validating it.

func TagFromTagged

func TagFromTagged(tag Tagged) Tag

func (Tag) String

func (t Tag) String() string

String implements reference.Reference

func (Tag) Tag

func (t Tag) Tag() string

Tag implements Tagged

type Tagged

type Tagged = reference.Tagged

Tagged is an object which has a tag.