source

Documentation

Overview

Package source provides an iterable Source interface of elements with path and content.

Index

• type File
  • func NewFile(ctx context.Context, root string, filters ...PathFilter) File
  • func (f File) Next() (item.Item, error)
• type Git
  • func NewGit(ctx context.Context, commit *object.Commit, filters ...PathFilter) (Git, error)
  • func (g Git) Next() (item.Item, error)
• type Memory
  • func (m *Memory) Next() (item.Item, error)
• type PathFilter
  • func FilterPrefix(filter string) PathFilter
  • func FilterSuffix(filter string) PathFilter
• type Repo
  • func NewRepo(url string) (*Repo, error)
  • func (r *Repo) Commit(reference string) (*object.Commit, error)
  • func (r *Repo) Update() error
• type Source

Types

type File

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

File takes a directory in the filesystem as source.

func NewFile

func NewFile(ctx context.Context, root string, filters ...PathFilter) File

NewFile returns a new File source, using the given filters.

func (File) Next

func (f File) Next() (item.Item, error)

Next implements the Source interface.

type Git

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

Git takes a git repo as origin

func NewGit

func NewGit(ctx context.Context, commit *object.Commit, filters ...PathFilter) (Git, error)

NewGit returns a new Source

func (Git) Next

func (g Git) Next() (item.Item, error)

Next implements the Source interface

type Memory

type Memory struct {
	Items []item.Memory
	// contains filtered or unexported fields
}

Memory is a static Source.

func (*Memory) Next

func (m *Memory) Next() (item.Item, error)

Next implements the Source interface.

type PathFilter

type PathFilter func(string) bool

PathFilter is used to exclude/include files in a FileSource.

func FilterPrefix

func FilterPrefix(filter string) PathFilter

FilterPrefix filters files by the given prefix.

func FilterSuffix

func FilterSuffix(filter string) PathFilter

FilterSuffix filters files by the given suffix.

type Repo

type Repo struct {
	URL string
	// contains filtered or unexported fields
}

Repo is a git repository

func NewRepo

func NewRepo(url string) (*Repo, error)

NewRepo returns a new repo

func (*Repo) Commit

func (r *Repo) Commit(reference string) (*object.Commit, error)

Commit returns the Commit for the given reference (example: refs/remotes/origin/master)

func (*Repo) Update

func (r *Repo) Update() error

Update pulls new contents

type Source

type Source interface {
	Next() (item.Item, error)
}

Source is an origin of Items.