buildpack

type Blob interface {
	// Open returns a io.ReadCloser for the contents of the Blob in tar format.
	Open() (io.ReadCloser, error)
}

type BuildModule interface {
	// Open returns a reader to a tar with contents structured as per the distribution spec
	// (currently '/cnb/buildpacks/{ID}/{version}/*', all entries with a zeroed-out
	// timestamp and root UID/GID).
	Open() (io.ReadCloser, error)
	Descriptor() Descriptor
}

type BuildModuleWriter struct {
	// contains filtered or unexported fields
}

type Descriptor interface {
	API() *api.Version
	EnsureStackSupport(stackID string, providedMixins []string, validateRunStageMixins bool) error
	EnsureTargetSupport(os, arch, distroName, distroVersion string) error
	EscapedID() string
	Info() dist.ModuleInfo
	Kind() string
	Order() dist.Order
	Stacks() []dist.Stack
	Targets() []dist.Target
}

type DownloadOptions struct {
	// Buildpack registry name. Defines where all registry buildpacks will be pulled from.
	RegistryName string

	// The base directory to use to resolve relative assets
	RelativeBaseDir string

	// The OS of the builder image
	ImageOS string

	// The OS/Architecture to download
	Platform string

	// Deprecated: the older alternative to buildpack URI
	ImageName string

	// The kind of module to download (valid values: "buildpack", "extension"). Defaults to "buildpack".
	ModuleKind string

	Daemon bool

	PullPolicy image.PullPolicy
}

type Downloader interface {
	Download(ctx context.Context, pathOrURI string) (blob.Blob, error)
}

type FlattenModuleInfos interface {
	FlattenModules() []ModuleInfos
}

type ImageFactory interface {
	NewImage(repoName string, local bool, imageOS string) (imgutil.Image, error)
}

type ImageFetcher interface {
	Fetch(ctx context.Context, name string, options image.FetchOptions) (imgutil.Image, error)
}

type LocatorType int

type Logger interface {
	Debug(msg string)
	Debugf(fmt string, v ...interface{})
	Info(msg string)
	Infof(fmt string, v ...interface{})
	Warn(msg string)
	Warnf(fmt string, v ...interface{})
	Error(msg string)
	Errorf(fmt string, v ...interface{})
}

type ManagedCollection interface {
	// AllModules returns all build modules handled by the manager.
	AllModules() []BuildModule

	// ExplodedModules returns all build modules that will be added to the output artifact as a single layer
	// containing a single module.
	ExplodedModules() []BuildModule

	// AddModules adds module information to the collection as flattened or not, depending on how the collection is configured.
	AddModules(main BuildModule, deps ...BuildModule)

	// FlattenedModules returns all build modules that will be added to the output artifact as a single layer
	// containing multiple modules.
	FlattenedModules() [][]BuildModule

	// ShouldFlatten returns true if the given module should be flattened.
	ShouldFlatten(module BuildModule) bool
}

type Metadata struct {
	dist.ModuleInfo
	Stacks []dist.Stack `toml:"stacks" json:"stacks"`
}

type ModuleInfos interface {
	BuildModule() []dist.ModuleInfo
}

type ModuleTar interface {
	Info() dist.ModuleInfo
	Path() string
}

type Package interface {
	Label(name string) (value string, err error)
	GetLayer(diffID string) (io.ReadCloser, error)
}

type PackageBuilder struct {
	// contains filtered or unexported fields
}

type PackageBuilderOption func(*options) error

type RegistryResolver interface {
	Resolve(registryName, bpURI string) (string, error)
}

type WorkableImage interface {
	SetLabel(string, string) error
	AddLayerWithDiffID(path, diffID string) error
}