reference

package

v0.0.0-...-8680cc4 Latest Latest Go to latest Published: Sep 11, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	// ErrInvalid is used to return error if reference is invalid
	ErrInvalid = errors.New("invalid reference")
)

func IsCanonicalDigested(ref Named) bool

IsCanonicalDigested return true if the ref is the canonical digested reference.

func IsNameTagged(ref Named) bool

IsNameTagged return true if the ref is the Named with tag.

func IsNamedOnly(ref Named) bool

IsNamedOnly return true if the ref is the Named without tag or digest.

type CanonicalDigested interface {
	Named
	Digest() digest.Digest
}

CanonicalDigested is an object which doesn't contains the tag information.

type Digested interface {
	Reference
	Digest() digest.Digest
}

Digested is an object which is digest.

type Named interface {
	Reference
	Name() string
}

Named is an object which has full name.

func Parse(ref string) (Named, error)

Parse parses ref into reference.Named.

func TrimTagForDigest(named Named) Named

TrimTagForDigest removes the tag information if the Named reference is digest.

func WithDefaultTagIfMissing(named Named) Named

WithDefaultTagIfMissing adds default tag "latest" for the Named reference.

func WithDigest(named Named, dig digest.Digest) Named

WithDigest adds digest for the Named reference.

func WithTag(named Named, tag string) Named

WithTag adds tag for the Named reference.

type Reference interface {
	String() string
}

Reference represents image name which may include hub/namespace/name:tag like registry.hub.docker.com/library/ubuntu:latest.

type Tagged interface {
	Named
	Tag() string
}

Tagged is an Named object contains tag.