pipes

Documentation

Index

• func Clone(pipe nuggit.Pipe) nuggit.Pipe
• func Deps(p nuggit.Pipe) iter.Seq[integrity.NameDigest]
• func Flatten(idx *Index, pipe nuggit.Pipe) (nuggit.Pipe, error)
• type Index
  • func (i *Index) Add(name, digest string, pipe nuggit.Pipe)
  • func (i *Index) All() iter.Seq2[integrity.NameDigest, nuggit.Pipe]
  • func (i *Index) Get(name, digest string) (nuggit.Pipe, bool)
  • func (i *Index) GetUnique(name string) (digest string, ok bool)
  • func (i *Index) GetUniquePipe(name string) (nuggit.Pipe, bool)
  • func (i *Index) Has(name, digest string) bool
  • func (i *Index) HasName(name string) bool
  • func (i *Index) Keys() iter.Seq[integrity.NameDigest]
  • func (i *Index) Qualified() (*Index, error)
  • func (idx *Index) Qualify(pipe nuggit.Pipe) (nuggit.Pipe, error)
  • func (i *Index) Remove(name, digest string)
  • func (i *Index) Reset()
  • func (i *Index) Topo() iter.Seq2[integrity.NameDigest, error]
  • func (i *Index) Values() iter.Seq[nuggit.Pipe]

Functions

func Clone

func Clone(pipe nuggit.Pipe) nuggit.Pipe

func Deps

func Deps(p nuggit.Pipe) iter.Seq[integrity.NameDigest]

func Flatten

func Flatten(idx *Index, pipe nuggit.Pipe) (nuggit.Pipe, error)

Flatten recursively replaces all pipe actions with their definitions returning a new Pipe or an error if the process failed. The flattened pipe is fully hermetric, making no references to other pipes. If the given pipe definition is not present in referencedPipes a ErrInvalidArgument error is returned.

NOTE: The returned pipe will have a different digest than the input pipe. If the value in the index was qualified it will be rendered useless.

TODO: check the digests of pipes in referencedPipes.

Types

type Index

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

func (*Index) Add

func (i *Index) Add(name, digest string, pipe nuggit.Pipe)

func (*Index) All

func (i *Index) All() iter.Seq2[integrity.NameDigest, nuggit.Pipe]

func (*Index) Get

func (i *Index) Get(name, digest string) (nuggit.Pipe, bool)

func (*Index) GetUnique

func (i *Index) GetUnique(name string) (digest string, ok bool)

func (*Index) GetUniquePipe

func (i *Index) GetUniquePipe(name string) (nuggit.Pipe, bool)

func (*Index) Has

func (i *Index) Has(name, digest string) bool

func (*Index) HasName

func (i *Index) HasName(name string) bool

func (*Index) Keys

func (i *Index) Keys() iter.Seq[integrity.NameDigest]

func (*Index) Qualified

func (i *Index) Qualified() (*Index, error)

Qualified returns a new index with all pipes qualified by digest.

func (*Index) Qualify

func (idx *Index) Qualify(pipe nuggit.Pipe) (nuggit.Pipe, error)

Qualify replaces all pipe references with a valid digest.

Qualify does not update the pipe digest in the index.

Use Qualified to create a new qualified index.

func (*Index) Remove

func (i *Index) Remove(name, digest string)

func (*Index) Reset

func (i *Index) Reset()

func (*Index) Topo

func (i *Index) Topo() iter.Seq2[integrity.NameDigest, error]

Topo proceeds over the keys of the index topologically.

If there are cycles in the topological order an error is passed to the yield function. Any other error is passed to yield as well.

Topo does not attempt to Qualify names when no digest is present.

func (*Index) Values

func (i *Index) Values() iter.Seq[nuggit.Pipe]