github.com/Heebron/moby@v0.0.0-20221111184709-6eab4f55faf7/api/server/router/image/backend.go (about)

     1  package image // import "github.com/docker/docker/api/server/router/image"
     2  
     3  import (
     4  	"context"
     5  	"io"
     6  
     7  	"github.com/docker/docker/api/types"
     8  	"github.com/docker/docker/api/types/filters"
     9  	"github.com/docker/docker/api/types/image"
    10  	"github.com/docker/docker/api/types/registry"
    11  	dockerimage "github.com/docker/docker/image"
    12  	specs "github.com/opencontainers/image-spec/specs-go/v1"
    13  )
    14  
    15  // Backend is all the methods that need to be implemented
    16  // to provide image specific functionality.
    17  type Backend interface {
    18  	imageBackend
    19  	importExportBackend
    20  	registryBackend
    21  }
    22  
    23  type imageBackend interface {
    24  	ImageDelete(ctx context.Context, imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error)
    25  	ImageHistory(imageName string) ([]*image.HistoryResponseItem, error)
    26  	Images(ctx context.Context, opts types.ImageListOptions) ([]*types.ImageSummary, error)
    27  	GetImage(ctx context.Context, refOrID string, options image.GetImageOpts) (*dockerimage.Image, error)
    28  	TagImage(imageName, repository, tag string) (string, error)
    29  	ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)
    30  }
    31  
    32  type importExportBackend interface {
    33  	LoadImage(ctx context.Context, inTar io.ReadCloser, outStream io.Writer, quiet bool) error
    34  	ImportImage(ctx context.Context, src string, repository string, platform *specs.Platform, tag string, msg string, inConfig io.ReadCloser, outStream io.Writer, changes []string) error
    35  	ExportImage(ctx context.Context, names []string, outStream io.Writer) error
    36  }
    37  
    38  type registryBackend interface {
    39  	PullImage(ctx context.Context, image, tag string, platform *specs.Platform, metaHeaders map[string][]string, authConfig *registry.AuthConfig, outStream io.Writer) error
    40  	PushImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, authConfig *registry.AuthConfig, outStream io.Writer) error
    41  	SearchRegistryForImages(ctx context.Context, searchFilters filters.Args, term string, limit int, authConfig *registry.AuthConfig, metaHeaders map[string][]string) (*registry.SearchResults, error)
    42  }