iter

Documentation

Index

• func ForEach(iter UpstreamIter, fn ForEachFunc) error
• type CheckoutPuller
  • func (p *CheckoutPuller) GetOptions() options.UpstreamOptions
  • func (p *CheckoutPuller) IsWithinPackage() bool
  • func (p *CheckoutPuller) Pull(rootFs billy.Filesystem, fs billy.Filesystem, path string) error
• type ForEachFunc
• type GitIter
  • func NewGitIter(opts options.UpstreamOptions, delta UpstreamDelta) (*GitIter, error)
  • func (i *GitIter) Next() (puller.Puller, error)
• type SingleIter
  • func (i *SingleIter) Next() (puller.Puller, error)
• type UpstreamDelta
  • func (d *UpstreamDelta) Apply(opts options.UpstreamOptions) (options.UpstreamOptions, error)
• type UpstreamIter
  • func IterForUpstream(upstream puller.Puller, delta UpstreamDelta) (UpstreamIter, error)
  • func NewSingleIter(upstream puller.Puller, delta UpstreamDelta) (UpstreamIter, error)

Functions

func ForEach

func ForEach(iter UpstreamIter, fn ForEachFunc) error

Types

type CheckoutPuller

type CheckoutPuller struct {
	Wt   *git.Worktree
	Opts options.UpstreamOptions
}

func (*CheckoutPuller) GetOptions

func (p *CheckoutPuller) GetOptions() options.UpstreamOptions

func (*CheckoutPuller) IsWithinPackage

func (p *CheckoutPuller) IsWithinPackage() bool

func (*CheckoutPuller) Pull

func (p *CheckoutPuller) Pull(rootFs billy.Filesystem, fs billy.Filesystem, path string) error

Pull checks out the commit from upstream options and copies the files to the destination.

Because this method mutatues the filesystem, it is not safe to call concurrently.

type ForEachFunc

type ForEachFunc func(p puller.Puller) error

type GitIter

type GitIter struct {
	// UpstreamOptions are the options for the current package.
	UpstreamOptions options.UpstreamOptions
	Delta           UpstreamDelta
	// contains filtered or unexported fields
}

func NewGitIter

func NewGitIter(opts options.UpstreamOptions, delta UpstreamDelta) (*GitIter, error)

func (*GitIter) Next

func (i *GitIter) Next() (puller.Puller, error)

type SingleIter

type SingleIter struct {
	Upstream puller.Puller
}

func (*SingleIter) Next

func (i *SingleIter) Next() (puller.Puller, error)

type UpstreamDelta

type UpstreamDelta options.UpstreamOptions

UpstreamDelta showing the changes to make when creating the next upstreams in an iterator.

func (*UpstreamDelta) Apply

func (d *UpstreamDelta) Apply(opts options.UpstreamOptions) (options.UpstreamOptions, error)

type UpstreamIter

type UpstreamIter interface {
	// Next returns the next puller in the iterator and points the head at the next item. If empty returns io.EOF.
	Next() (puller.Puller, error)
}

func IterForUpstream

func IterForUpstream(upstream puller.Puller, delta UpstreamDelta) (UpstreamIter, error)

func NewSingleIter

func NewSingleIter(upstream puller.Puller, delta UpstreamDelta) (UpstreamIter, error)