transfer

Documentation

Index

• type Config
• type Fetcher
• type ImageExportStreamer
• type ImageExporter
• type ImageFetcher
• type ImageFilterer
• type ImageGetter
• type ImageImportStreamer
• type ImageImporter
• type ImageLookup
• type ImagePusher
• type ImageResolver
• type ImageStorer
• type ImageUnpacker
• type Opt
  • func WithProgress(f ProgressFunc) Opt
• type Progress
• type ProgressFunc
• type Pusher
• type Transferrer
• type UnpackConfiguration

Types

type Config

type Config struct {
	Progress ProgressFunc
}

type Fetcher

type Fetcher interface {
	Fetch(context.Context, ocispec.Descriptor) (io.ReadCloser, error)
}

type ImageExportStreamer

type ImageExportStreamer interface {
	ExportStream(context.Context) (io.WriteCloser, string, error)
}

type ImageExporter

type ImageExporter interface {
	Export(context.Context, content.Store, []images.Image) error
}

ImageExporter exports images to a writer

type ImageFetcher

type ImageFetcher interface {
	ImageResolver

	Fetcher(ctx context.Context, ref string) (Fetcher, error)
}

type ImageFilterer

type ImageFilterer interface {
	ImageFilter(images.HandlerFunc, content.Store) images.HandlerFunc
}

ImageFilterer is used to filter out child objects of an image

type ImageGetter

type ImageGetter interface {
	Get(context.Context, images.Store) (images.Image, error)
}

ImageGetter is type which returns an image from an image store

type ImageImportStreamer

type ImageImportStreamer interface {
	ImportStream(context.Context) (io.Reader, string, error)
}

ImageImportStreamer returns an import streamer based on OCI or Docker image tar archives. The stream should be a raw tar stream and without compression.

type ImageImporter

type ImageImporter interface {
	Import(context.Context, content.Store) (ocispec.Descriptor, error)
}

ImageImporter imports an image into a content store

type ImageLookup

type ImageLookup interface {
	Lookup(context.Context, images.Store) ([]images.Image, error)
}

ImageLookup is a type which returns images from an image store based on names or prefixes

type ImagePusher

type ImagePusher interface {
	Pusher(context.Context, ocispec.Descriptor) (Pusher, error)
}

type ImageResolver

type ImageResolver interface {
	Resolve(ctx context.Context) (name string, desc ocispec.Descriptor, err error)
}

type ImageStorer

type ImageStorer interface {
	Store(context.Context, ocispec.Descriptor, images.Store) ([]images.Image, error)
}

ImageStorer is a type which is capable of storing images for the provided descriptor. The descriptor may be any type of manifest including an index with multiple image references.

type ImageUnpacker

type ImageUnpacker interface {
	UnpackPlatforms() []UnpackConfiguration
}

type Opt

type Opt func(*Config)

func WithProgress

func WithProgress(f ProgressFunc) Opt

type Progress

type Progress struct {
	Event    string
	Name     string
	Parents  []string
	Progress int64
	Total    int64
}

Progress is used to represent a particular progress event or incremental update for the provided named object. The parents represent the names of the objects which initiated the progress for the provided named object. The name and what object it represents is determined by the implementation.

type ProgressFunc

type ProgressFunc func(Progress)

type Pusher

type Pusher interface {
	Push(context.Context, ocispec.Descriptor) (content.Writer, error)
}

type Transferrer

type Transferrer interface {
	Transfer(ctx context.Context, source interface{}, destination interface{}, opts ...Opt) error
}

type UnpackConfiguration

type UnpackConfiguration struct {
	Platform    ocispec.Platform
	Snapshotter string
}

UnpackConfiguration specifies the platform and snapshotter to use for resolving the unpack Platform, if snapshotter is not specified the platform default will be used.