reference

Documentation

Index

• Variables
• func IsDir(from string) bool
• func IsFile(from string) bool
• func IsHTTP(from string) bool
• func IsOCI(from string) bool
• func IsRegistryScheme(s Schema) bool
• func IsS3(from string) bool
• type Reference
  • func Parse(s string) (Reference, error)
  • func ParseRegistryReference(ref string) (Reference, error)
  • func (r Reference) Descriptor() ocispecv1.Descriptor
  • func (r Reference) IsZero() bool
  • func (r Reference) Merge(ref Reference) Reference
  • func (r Reference) RepoReference() string
  • func (r Reference) String() string
  • func (r Reference) URL(plainHttp bool) Url
  • func (r Reference) WithDescriptor(desc ocispecv1.Descriptor) Reference
• type Schema
  • func GetScheme(s string) (Schema, error)
  • func (s Schema) Eq(v string) bool
  • func (s Schema) IsPrefix(v string) bool
  • func (s Schema) String() string
• type Url
  • func (r Url) Blobs() string
  • func (r Url) Manifests() string
  • func (r Url) Mount(mount digest.Digest, from string) string
  • func (r Url) Path() string
  • func (r Url) Uploads() string
  • func (r Url) UploadsUrl() *url.URL

Variables

var (
	// ErrInvalid is returned when there is an invalid reference
	ErrInvalid           = errors.New("invalid reference")
	ErrSchemeRequired    = errors.New("scheme required")
	ErrSchemeUnsupported = errors.New("scheme unsupported")

	// ErrHostnameRequired is returned when the hostname is required
	ErrHostnameRequired = errors.New("hostname required")
)

Functions

func IsDir

func IsDir(from string) bool

func IsFile

func IsFile(from string) bool

func IsHTTP

func IsHTTP(from string) bool

func IsOCI

func IsOCI(from string) bool

func IsRegistryScheme

func IsRegistryScheme(s Schema) bool

func IsS3

func IsS3(from string) bool

Types

type Reference

type Reference struct {
	Scheme Schema
	Host   string
	Path   string
	Ref    string
	// contains filtered or unexported fields
}

func Parse

func Parse(s string) (Reference, error)

func ParseRegistryReference

func ParseRegistryReference(ref string) (Reference, error)

func (Reference) Descriptor

func (r Reference) Descriptor() ocispecv1.Descriptor

func (Reference) IsZero

func (r Reference) IsZero() bool

func (Reference) Merge

func (r Reference) Merge(ref Reference) Reference

func (Reference) RepoReference

func (r Reference) RepoReference() string

func (Reference) String

func (r Reference) String() string

func (Reference) URL

func (r Reference) URL(plainHttp bool) Url

func (Reference) WithDescriptor

func (r Reference) WithDescriptor(desc ocispecv1.Descriptor) Reference

type Schema

type Schema string

const (
	OciScheme      Schema = "oci"
	RegistryScheme Schema = "cr"
	DirSchema      Schema = "dir"
	FileSchema     Schema = "file"
	S3Schema       Schema = "s3"
	S3httpSchema   Schema = "s3+http"
	HttpSchema     Schema = "http"
	HttpsSchema    Schema = "https"
)

func GetScheme

func GetScheme(s string) (Schema, error)

func (Schema) Eq

func (s Schema) Eq(v string) bool

func (Schema) IsPrefix

func (s Schema) IsPrefix(v string) bool

func (Schema) String

func (s Schema) String() string

type Url

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

func (Url) Blobs

func (r Url) Blobs() string

func (Url) Manifests

func (r Url) Manifests() string

func (Url) Mount

func (r Url) Mount(mount digest.Digest, from string) string

func (Url) Path

func (r Url) Path() string

func (Url) Uploads

func (r Url) Uploads() string

func (Url) UploadsUrl

func (r Url) UploadsUrl() *url.URL