imagefmt

Documentation

Overview

Package imagefmt exposes functions to dynamically register methods to detect different types of container image formats.

Index

• Variables
• func Extract(format, path string, headers map[string]string, toExtract []string) (tarutil.FilesMap, error)
• func Extractors() map[string]Extractor
• func RegisterExtractor(name string, d Extractor)
• func UnregisterExtractor(name string)
• type Extractor

Variables

var (
	// ErrCouldNotFindLayer is returned when we could not download or open the layer file.
	ErrCouldNotFindLayer = commonerr.NewBadRequestError("could not find layer")
)

Functions

func Extract

func Extract(format, path string, headers map[string]string, toExtract []string) (tarutil.FilesMap, error)

Extract streams an image layer from disk or over HTTP, determines the image format, then extracts the files specified.

func Extractors

func Extractors() map[string]Extractor

Extractors returns the list of the registered extractors.

func RegisterExtractor

func RegisterExtractor(name string, d Extractor)

RegisterExtractor makes an extractor available by the provided name.

If called twice with the same name, the name is blank, or if the provided Extractor is nil, this function panics.

func UnregisterExtractor

func UnregisterExtractor(name string)

UnregisterExtractor removes a Extractor with a particular name from the list.

Types

type Extractor

type Extractor interface {
	// ExtractFiles produces a tarutil.FilesMap from a image layer.
	ExtractFiles(layer io.ReadCloser, filenames []string) (tarutil.FilesMap, error)
}

Extractor represents an ability to extract files from a particular container image format.