types

Documentation

Overview

Package types holds common OCI media types.

Index

• type MediaType
  • func (m MediaType) IsConfig() bool
  • func (m MediaType) IsDistributable() bool
  • func (m MediaType) IsImage() bool
  • func (m MediaType) IsIndex() bool
  • func (m MediaType) IsLayer() bool
  • func (m MediaType) IsSchema1() bool

Types

type MediaType

type MediaType string

MediaType is an enumeration of the supported mime types that an element of an image might have.

const (
	OCIContentDescriptor           MediaType = "application/vnd.oci.descriptor.v1+json"
	OCIImageIndex                  MediaType = "application/vnd.oci.image.index.v1+json"
	OCIManifestSchema1             MediaType = "application/vnd.oci.image.manifest.v1+json"
	OCIConfigJSON                  MediaType = "application/vnd.oci.image.config.v1+json"
	OCILayer                       MediaType = "application/vnd.oci.image.layer.v1.tar+gzip"
	OCILayerZStd                   MediaType = "application/vnd.oci.image.layer.v1.tar+zstd"
	OCIRestrictedLayer             MediaType = "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip"
	OCIUncompressedLayer           MediaType = "application/vnd.oci.image.layer.v1.tar"
	OCIUncompressedRestrictedLayer MediaType = "application/vnd.oci.image.layer.nondistributable.v1.tar"

	DockerManifestSchema1       MediaType = "application/vnd.docker.distribution.manifest.v1+json"
	DockerManifestSchema1Signed MediaType = "application/vnd.docker.distribution.manifest.v1+prettyjws"
	DockerManifestSchema2       MediaType = "application/vnd.docker.distribution.manifest.v2+json"
	DockerManifestList          MediaType = "application/vnd.docker.distribution.manifest.list.v2+json"
	DockerLayer                 MediaType = "application/vnd.docker.image.rootfs.diff.tar.gzip"
	DockerConfigJSON            MediaType = "application/vnd.docker.container.image.v1+json"
	DockerPluginConfig          MediaType = "application/vnd.docker.plugin.v1+json"
	DockerForeignLayer          MediaType = "application/vnd.docker.image.rootfs.foreign.diff.tar.gzip"
	DockerUncompressedLayer     MediaType = "application/vnd.docker.image.rootfs.diff.tar"

	OCIVendorPrefix    = "vnd.oci"
	DockerVendorPrefix = "vnd.docker"
)

The collection of known MediaType values.

func (MediaType) IsConfig

func (m MediaType) IsConfig() bool

IsConfig returns true if the mediaType represents a config, as opposed to something else, like an image.

func (MediaType) IsDistributable

func (m MediaType) IsDistributable() bool

IsDistributable returns true if a layer is distributable, see: https://github.com/opencontainers/image-spec/blob/master/layer.md#non-distributable-layers

func (MediaType) IsImage

func (m MediaType) IsImage() bool

IsImage returns true if the mediaType represents an image manifest, as opposed to something else, like an index.

func (MediaType) IsIndex

func (m MediaType) IsIndex() bool

IsIndex returns true if the mediaType represents an index, as opposed to something else, like an image.

func (MediaType) IsLayer

func (m MediaType) IsLayer() bool

func (MediaType) IsSchema1

func (m MediaType) IsSchema1() bool