github.com/kaisenlinux/docker.io@v0.0.0-20230510090727-ea55db55fac7/engine/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  	specs "github.com/opencontainers/image-spec/specs-go/v1"
    12  )
    13  
    14  // Backend is all the methods that need to be implemented
    15  // to provide image specific functionality.
    16  type Backend interface {
    17  	imageBackend
    18  	importExportBackend
    19  	registryBackend
    20  }
    21  
    22  type imageBackend interface {
    23  	ImageDelete(imageRef string, force, prune bool) ([]types.ImageDeleteResponseItem, error)
    24  	ImageHistory(imageName string) ([]*image.HistoryResponseItem, error)
    25  	Images(imageFilters filters.Args, all bool, withExtraAttrs bool) ([]*types.ImageSummary, error)
    26  	LookupImage(name string) (*types.ImageInspect, error)
    27  	TagImage(imageName, repository, tag string) (string, error)
    28  	ImagesPrune(ctx context.Context, pruneFilters filters.Args) (*types.ImagesPruneReport, error)
    29  }
    30  
    31  type importExportBackend interface {
    32  	LoadImage(inTar io.ReadCloser, outStream io.Writer, quiet bool) error
    33  	ImportImage(src string, repository, platform string, tag string, msg string, inConfig io.ReadCloser, outStream io.Writer, changes []string) error
    34  	ExportImage(names []string, outStream io.Writer) error
    35  }
    36  
    37  type registryBackend interface {
    38  	PullImage(ctx context.Context, image, tag string, platform *specs.Platform, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error
    39  	PushImage(ctx context.Context, image, tag string, metaHeaders map[string][]string, authConfig *types.AuthConfig, outStream io.Writer) error
    40  	SearchRegistryForImages(ctx context.Context, filtersArgs string, term string, limit int, authConfig *types.AuthConfig, metaHeaders map[string][]string) (*registry.SearchResults, error)
    41  }