buildpackplan

Documentation

Index

• type Metadata
• type Plan
  • func ShallowMerge(a, b Plan) (Plan, error)
• type Plans
  • func (p Plans) Get(name string) []Plan
  • func (p Plans) GetMerged(name string, merge func(a, b Plan) (Plan, error)) (Plan, bool, error)
  • func (p Plans) GetShallowMerged(name string) (Plan, bool, error)
  • func (p Plans) Has(name string) bool
• type Writer

Types

type Metadata

type Metadata = buildpackplan.Metadata

Metadata is the metadata of the plan.

type Plan

type Plan = buildpackplan.Plan

Plan represents a contractual buildpack plan.

func ShallowMerge

func ShallowMerge(a, b Plan) (Plan, error)

ShallowMerge merges two Plans together. Declared versions are combined with a comma delimiter and metadata is combined with the values for b taking priority over the values of a when keys are duplicated.

type Plans

type Plans struct {
	buildpackplan.Plans
}

Plan represents a contractual buildpack plan.

func (Plans) Get

func (p Plans) Get(name string) []Plan

Get returns a collection of Plan's that have a given name.

func (Plans) GetMerged

func (p Plans) GetMerged(name string, merge func(a, b Plan) (Plan, error)) (Plan, bool, error)

GetMerged returns a single Plan that is a merged version of all of the Plan's that have a given name. A merge function is used to describe how two entries are merged together. Returns true if any matching Plan's were found, false otherwise.

func (Plans) GetShallowMerged

func (p Plans) GetShallowMerged(name string) (Plan, bool, error)

GetShallowMerged returns a single Plan that is a merged version of all of the Plan's that have a given name. Merging is accomplished with the ShallowMerge function. Returns true if any matching Plan's were found, false otherwise.

func (Plans) Has

func (p Plans) Has(name string) bool

Has returns whether there is a Plan with a given name.

type Writer

type Writer = buildpackplan.Writer

Writer is a function write writes the contents of a Plans