artdesc

Documentation

Index

• Constants
• func ArchiveBlobTypes() []string
• func ArtifactMimeType(cur, def string, legacy bool) string
• func ContentTypes() []string
• func DescriptorTypes() []string
• func Encode(d *Artifact) ([]byte, error)
• func EncodeIndex(d *Index) ([]byte, error)
• func EncodeManifest(d *Manifest) ([]byte, error)
• func IsDigest(version string) (bool, digest.Digest)
• func IsOCIMediaType(media string) bool
• func MapArtifactBlobMimeType(blob accessio.BlobAccess, legacy bool) accessio.BlobAccess
• func MapArtifactMimeType(mime string, legacy bool) string
• func ToArchiveMediaTypes(media string) []string
• func ToContentMediaType(media string) string
• func ToDescriptorMediaType(media string) string
• type Artifact
  • func Decode(data []byte) (*Artifact, error)
  • func New() *Artifact
  • func NewIndexArtifact() *Artifact
  • func NewManifestArtifact() *Artifact
  • func (d *Artifact) GetBlobDescriptor(digest digest.Digest) *Descriptor
  • func (d *Artifact) Index() *Index
  • func (d *Artifact) IsIndex() bool
  • func (d *Artifact) IsManifest() bool
  • func (d *Artifact) IsValid() bool
  • func (d *Artifact) Manifest() *Manifest
  • func (d Artifact) MarshalJSON() ([]byte, error)
  • func (d *Artifact) MimeType() string
  • func (d *Artifact) SetIndex(i *Index) error
  • func (d *Artifact) SetManifest(m *Manifest) error
  • func (d *Artifact) ToBlobAccess() (accessio.BlobAccess, error)
  • func (d *Artifact) UnmarshalJSON(data []byte) error
• type BlobDescriptorSource
• type Descriptor
  • func DefaultBlobDescriptor(blob accessio.BlobAccess) *Descriptor
• type ImageConfig
  • func ParseImageConfig(blob accessio.BlobAccess) (*ImageConfig, error)
• type Index
  • func DecodeIndex(data []byte) (*Index, error)
  • func NewIndex() *Index
  • func (i *Index) AddManifest(d *Descriptor)
  • func (i *Index) GetBlobDescriptor(digest digest.Digest) *Descriptor
  • func (i *Index) IsValid() bool
  • func (i *Index) MimeType() string
  • func (i *Index) ToBlobAccess() (accessio.BlobAccess, error)
• type Manifest
  • func DecodeManifest(data []byte) (*Manifest, error)
  • func NewManifest() *Manifest
  • func (m *Manifest) GetBlobDescriptor(digest digest.Digest) *Descriptor
  • func (i *Manifest) IsValid() bool
  • func (m *Manifest) MimeType() string
  • func (m *Manifest) ToBlobAccess() (accessio.BlobAccess, error)
• type Platform

Constants

const (
	MediaTypeImageManifest  = ociv1.MediaTypeImageManifest
	MediaTypeImageIndex     = ociv1.MediaTypeImageIndex
	MediaTypeImageLayer     = ociv1.MediaTypeImageLayer
	MediaTypeImageLayerGzip = ociv1.MediaTypeImageLayerGzip

	MediaTypeDockerSchema2Manifest     = images.MediaTypeDockerSchema2Manifest
	MediaTypeDockerSchema2ManifestList = images.MediaTypeDockerSchema2ManifestList

	MediaTypeImageConfig = ociv1.MediaTypeImageConfig
)

const SchemeVersion = helper.SchemeVersion

Functions

func ArchiveBlobTypes

func ArchiveBlobTypes() []string

func ArtifactMimeType

func ArtifactMimeType(cur, def string, legacy bool) string

func ContentTypes

func ContentTypes() []string

func DescriptorTypes

func DescriptorTypes() []string

func Encode

func Encode(d *Artifact) ([]byte, error)

func EncodeIndex

func EncodeIndex(d *Index) ([]byte, error)

func EncodeManifest

func EncodeManifest(d *Manifest) ([]byte, error)

func IsDigest

func IsDigest(version string) (bool, digest.Digest)

func IsOCIMediaType

func IsOCIMediaType(media string) bool

func MapArtifactBlobMimeType

func MapArtifactBlobMimeType(blob accessio.BlobAccess, legacy bool) accessio.BlobAccess

func MapArtifactMimeType

func MapArtifactMimeType(mime string, legacy bool) string

func ToArchiveMediaTypes

func ToArchiveMediaTypes(media string) []string

func ToContentMediaType

func ToContentMediaType(media string) string

func ToDescriptorMediaType

func ToDescriptorMediaType(media string) string

Types

type Artifact

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

Artifact is the unified representation of an OCI artifact according to https://github.com/opencontainers/image-spec/blob/main/manifest.md It is either an image manifest or an image index manifest (fat image).

func Decode

func Decode(data []byte) (*Artifact, error)

func New

func New() *Artifact

func NewIndexArtifact

func NewIndexArtifact() *Artifact

func NewManifestArtifact

func NewManifestArtifact() *Artifact

func (*Artifact) GetBlobDescriptor

func (d *Artifact) GetBlobDescriptor(digest digest.Digest) *Descriptor

func (*Artifact) Index

func (d *Artifact) Index() *Index

func (*Artifact) IsIndex

func (d *Artifact) IsIndex() bool

func (*Artifact) IsManifest

func (d *Artifact) IsManifest() bool

func (*Artifact) IsValid

func (d *Artifact) IsValid() bool

func (*Artifact) Manifest

func (d *Artifact) Manifest() *Manifest

func (Artifact) MarshalJSON

func (d Artifact) MarshalJSON() ([]byte, error)

func (*Artifact) MimeType

func (d *Artifact) MimeType() string

func (*Artifact) SetIndex

func (d *Artifact) SetIndex(i *Index) error

func (*Artifact) SetManifest

func (d *Artifact) SetManifest(m *Manifest) error

func (*Artifact) ToBlobAccess

func (d *Artifact) ToBlobAccess() (accessio.BlobAccess, error)

func (*Artifact) UnmarshalJSON

func (d *Artifact) UnmarshalJSON(data []byte) error

type BlobDescriptorSource

type BlobDescriptorSource interface {
	GetBlobDescriptor(digest.Digest) *Descriptor
	MimeType() string
	IsValid() bool
}

type Descriptor

type Descriptor = ociv1.Descriptor

func DefaultBlobDescriptor

func DefaultBlobDescriptor(blob accessio.BlobAccess) *Descriptor

type ImageConfig

type ImageConfig = ociv1.Image

func ParseImageConfig

func ParseImageConfig(blob accessio.BlobAccess) (*ImageConfig, error)

type Index

type Index ociv1.Index

func DecodeIndex

func DecodeIndex(data []byte) (*Index, error)

func NewIndex

func NewIndex() *Index

func (*Index) AddManifest

func (i *Index) AddManifest(d *Descriptor)

func (*Index) GetBlobDescriptor

func (i *Index) GetBlobDescriptor(digest digest.Digest) *Descriptor

func (*Index) IsValid

func (i *Index) IsValid() bool

func (*Index) MimeType

func (i *Index) MimeType() string

func (*Index) ToBlobAccess

func (i *Index) ToBlobAccess() (accessio.BlobAccess, error)

type Manifest

type Manifest ociv1.Manifest

func DecodeManifest

func DecodeManifest(data []byte) (*Manifest, error)

func NewManifest

func NewManifest() *Manifest

func (*Manifest) GetBlobDescriptor

func (m *Manifest) GetBlobDescriptor(digest digest.Digest) *Descriptor

func (*Manifest) IsValid

func (i *Manifest) IsValid() bool

func (*Manifest) MimeType

func (m *Manifest) MimeType() string

func (*Manifest) ToBlobAccess

func (m *Manifest) ToBlobAccess() (accessio.BlobAccess, error)

type Platform

type Platform = ociv1.Platform