partial

Documentation

Overview

Package partial defines methods for building up a v1.Image from minimal subsets that are sufficient for defining a v1.Image.

Index

• func BlobSize(i WithManifest, h v1.Hash) (int64, error)
• func BlobToDiffID(i WithManifestAndConfigFile, h v1.Hash) (v1.Hash, error)
• func CompressedToImage(cic CompressedImageCore) (v1.Image, error)
• func CompressedToLayer(ul CompressedLayer) (v1.Layer, error)
• func ConfigFile(i WithRawConfigFile) (*v1.ConfigFile, error)
• func ConfigLayer(i WithRawConfigFile) (v1.Layer, error)
• func ConfigName(i WithRawConfigFile) (v1.Hash, error)
• func DiffIDToBlob(wm WithManifestAndConfigFile, h v1.Hash) (v1.Hash, error)
• func DiffIDs(i WithConfigFile) ([]v1.Hash, error)
• func Digest(i WithRawManifest) (v1.Hash, error)
• func FSLayers(i WithManifest) ([]v1.Hash, error)
• func Layer(wul WithUncompressedLayer, h v1.Hash) (io.ReadCloser, error)
• func Manifest(i WithRawManifest) (*v1.Manifest, error)
• func RawConfigFile(i WithConfigFile) ([]byte, error)
• func RawManifest(i WithManifest) ([]byte, error)
• func UncompressedBlob(b WithBlob, h v1.Hash) (io.ReadCloser, error)
• func UncompressedToImage(uic UncompressedImageCore) (v1.Image, error)
• func UncompressedToLayer(ul UncompressedLayer) (v1.Layer, error)
• type CompressedImageCore
• type CompressedLayer
• type UncompressedImageCore
• type UncompressedLayer
• type WithBlob
• type WithConfigFile
• type WithDiffID
• type WithManifest
• type WithManifestAndConfigFile
• type WithRawConfigFile
• type WithRawManifest
• type WithUncompressedLayer

Functions

func BlobSize

func BlobSize(i WithManifest, h v1.Hash) (int64, error)

BlobSize is a helper for implementing v1.Image

func BlobToDiffID

func BlobToDiffID(i WithManifestAndConfigFile, h v1.Hash) (v1.Hash, error)

BlobToDiffID is a helper for mapping between compressed and uncompressed blob hashes.

func CompressedToImage

func CompressedToImage(cic CompressedImageCore) (v1.Image, error)

CompressedToImage fills in the missing methods from a CompressedImageCore so that it implements v1.Image

func CompressedToLayer

func CompressedToLayer(ul CompressedLayer) (v1.Layer, error)

CompressedToLayer fills in the missing methods from a CompressedLayer so that it implements v1.Layer

func ConfigFile

func ConfigFile(i WithRawConfigFile) (*v1.ConfigFile, error)

ConfigFile is a helper for implementing v1.Image

func ConfigLayer

func ConfigLayer(i WithRawConfigFile) (v1.Layer, error)

ConfigLayer implements v1.Layer from the raw config bytes. This is so that clients (e.g. remote) can access the config as a blob.

func ConfigName

func ConfigName(i WithRawConfigFile) (v1.Hash, error)

ConfigName is a helper for implementing v1.Image

func DiffIDToBlob

func DiffIDToBlob(wm WithManifestAndConfigFile, h v1.Hash) (v1.Hash, error)

DiffIDToBlob is a helper for mapping between uncompressed and compressed blob hashes.

func DiffIDs

func DiffIDs(i WithConfigFile) ([]v1.Hash, error)

DiffIDs is a helper for implementing v1.Image

func Digest

func Digest(i WithRawManifest) (v1.Hash, error)

Digest is a helper for implementing v1.Image

func FSLayers

func FSLayers(i WithManifest) ([]v1.Hash, error)

FSLayers is a helper for implementing v1.Image

func Layer

func Layer(wul WithUncompressedLayer, h v1.Hash) (io.ReadCloser, error)

Layer is the same as Blob, but takes the "diff id".

func Manifest

func Manifest(i WithRawManifest) (*v1.Manifest, error)

Manifest is a helper for implementing v1.Image

func RawConfigFile

func RawConfigFile(i WithConfigFile) ([]byte, error)

RawConfigFile is a helper for implementing v1.Image

func RawManifest

func RawManifest(i WithManifest) ([]byte, error)

RawManifest is a helper for implementing v1.Image

func UncompressedBlob

func UncompressedBlob(b WithBlob, h v1.Hash) (io.ReadCloser, error)

UncompressedBlob returns a ReadCloser for streaming the blob's content uncompressed.

func UncompressedToImage

func UncompressedToImage(uic UncompressedImageCore) (v1.Image, error)

UncompressedToImage fills in the missing methods from an UncompressedImageCore so that it implements v1.Image.

func UncompressedToLayer

func UncompressedToLayer(ul UncompressedLayer) (v1.Layer, error)

UncompressedToLayer fills in the missing methods from an UncompressedLayer so that it implements v1.Layer

Types

type CompressedImageCore

type CompressedImageCore interface {

	// RawManifest returns the serialized bytes of the manifest.
	RawManifest() ([]byte, error)

	// LayerByDigest is a variation on the v1.Image method, which returns
	// a CompressedLayer instead.
	LayerByDigest(v1.Hash) (CompressedLayer, error)
	// contains filtered or unexported methods
}

CompressedImageCore represents the base minimum interface a natively compressed image must implement for us to produce a v1.Image.

type CompressedLayer

type CompressedLayer interface {
	// Digest returns the Hash of the compressed layer.
	Digest() (v1.Hash, error)

	// Compressed returns an io.ReadCloser for the compressed layer contents.
	Compressed() (io.ReadCloser, error)

	// Size returns the compressed size of the Layer.
	Size() (int64, error)
}

CompressedLayer represents the bare minimum interface a natively compressed layer must implement for us to produce a v1.Layer

type UncompressedImageCore

type UncompressedImageCore interface {

	// LayerByDiffID is a variation on the v1.Image method, which returns
	// an UncompressedLayer instead.
	LayerByDiffID(v1.Hash) (UncompressedLayer, error)
	// contains filtered or unexported methods
}

UncompressedImageCore represents the bare minimum interface a natively uncompressed image must implement for us to produce a v1.Image

type UncompressedLayer

type UncompressedLayer interface {
	// DiffID returns the Hash of the uncompressed layer.
	DiffID() (v1.Hash, error)

	// Uncompressed returns an io.ReadCloser for the uncompressed layer contents.
	Uncompressed() (io.ReadCloser, error)
}

UncompressedLayer represents the bare minimum interface a natively uncompressed layer must implement for us to produce a v1.Layer

type WithBlob

type WithBlob interface {
	// Blob returns a ReadCloser for streaming the blob's content.
	Blob(v1.Hash) (io.ReadCloser, error)
}

WithBlob defines the subset of v1.Image used by these helper methods

type WithConfigFile

type WithConfigFile interface {
	// ConfigFile returns this image's config file.
	ConfigFile() (*v1.ConfigFile, error)
}

WithConfigFile defines the subset of v1.Image used by these helper methods

type WithDiffID

type WithDiffID interface {
	DiffID() (v1.Hash, error)
}

WithDiffID defines the subset of v1.Layer for exposing the DiffID method.

type WithManifest

type WithManifest interface {
	// Manifest returns this image's Manifest object.
	Manifest() (*v1.Manifest, error)
}

WithManifest defines the subset of v1.Image used by these helper methods

type WithManifestAndConfigFile

type WithManifestAndConfigFile interface {
	WithConfigFile

	// Manifest returns this image's Manifest object.
	Manifest() (*v1.Manifest, error)
}

WithManifestAndConfigFile defines the subset of v1.Image used by these helper methods

type WithRawConfigFile

type WithRawConfigFile interface {
	// RawConfigFile returns the serialized bytes of this image's config file.
	RawConfigFile() ([]byte, error)
}

WithRawConfigFile defines the subset of v1.Image used by these helper methods

type WithRawManifest

type WithRawManifest interface {
	// RawManifest returns the serialized bytes of this image's config file.
	RawManifest() ([]byte, error)
}

WithRawManifest defines the subset of v1.Image used by these helper methods

type WithUncompressedLayer

type WithUncompressedLayer interface {
	// UncompressedLayer is like UncompressedBlob, but takes the "diff id".
	UncompressedLayer(v1.Hash) (io.ReadCloser, error)
}

WithUncompressedLayer defines the subset of v1.Image used by these helper methods