dirimage

Documentation

Index

• Constants
• Variables
• type DirImage
  • func Convert(img v1.Image) (*DirImage, error)
  • func New(dir string, img v1.Image) *DirImage
  • func Read(ctx context.Context, dir string, opt ...Option) (*DirImage, error)
  • func (di *DirImage) Length() int64
  • func (di *DirImage) Write(ctx context.Context, destinationDir string, opt ...Option) error
  • func (di *DirImage) WriteConfigAndManifest(destinationDir string) error
• type Option
  • func WithChunkSize(chunkSize int64) Option
  • func WithLogFunction(log func(fmt string, args ...any)) Option
  • func WithOmitLayersContent() Option
  • func WithProgressChannel(progress chan<- ProgressUpdate) Option
  • func WithWorkersCount(workersCount int) Option
• type ProgressUpdate

Constants

const LocalConfigFilename = ".oci.config.json"

const LocalManifestFilename = ".oci.manifest.json"

Variables

var ConfigMediaType = types.OCIConfigJSON

var ManifestMediaType = types.OCIManifestSchema1

https://opencontainers.org/posts/blog/2024-03-13-image-and-distribution-1-1/

Types

type DirImage

type DirImage struct {
	v1.Image
	BytesReadCount    atomic.Int64
	BytesWrittenCount atomic.Int64
	BytesSkippedCount atomic.Int64
	// contains filtered or unexported fields
}

func Convert

func Convert(img v1.Image) (*DirImage, error)

func New

func New(dir string, img v1.Image) *DirImage

func Read

func Read(ctx context.Context, dir string, opt ...Option) (*DirImage, error)

func (*DirImage) Length

func (di *DirImage) Length() int64

func (*DirImage) Write

func (di *DirImage) Write(ctx context.Context, destinationDir string, opt ...Option) error

func (*DirImage) WriteConfigAndManifest

func (di *DirImage) WriteConfigAndManifest(destinationDir string) error

type Option

type Option func(opts *options)

func WithChunkSize

func WithChunkSize(chunkSize int64) Option

func WithLogFunction

func WithLogFunction(log func(fmt string, args ...any)) Option

func WithOmitLayersContent

func WithOmitLayersContent() Option

func WithProgressChannel

func WithProgressChannel(progress chan<- ProgressUpdate) Option

func WithWorkersCount

func WithWorkersCount(workersCount int) Option

type ProgressUpdate

type ProgressUpdate struct {
	BytesProcessed int64
	BytesTotal     int64
}