github_stat

Documentation

Index

• Variables
• type ContentProvider
• type FileForPath
• type LOCCacher
• type Opener
• type Service
  • func New(locCacher LOCCacher, contentProvider ContentProvider, maxParallelWork int) *Service
  • func (s *Service) GetStat(ctx context.Context, user, repo, branch string, filter, matcher *string, ...) (*loc_count.StatTree, error)
• type TempStorage

Variables

var ErrNoData = fmt.Errorf("no data")

var ErrRepoTooLarge = rest.BadRequest{Msg: "Too large repository"}

Types

type ContentProvider

type ContentProvider interface {
	GetContent(ctx context.Context, user, repo, branch string, tempStorage TempStorage) (_ []FileForPath, close func() error, _ error)
}

type FileForPath

type FileForPath struct {
	Path   string
	Opener Opener
}

type LOCCacher

type LOCCacher interface {
	SetLOCs(ctx context.Context, user, repo, branch string, locs []loc_count.LOCForPath) error
	SetTooLarge(ctx context.Context, user, repo, branch string) error
	GetLOCs(ctx context.Context, user, repo, branch string) ([]loc_count.LOCForPath, error) // error may be ErrNoData
}

type Opener

type Opener = func() (io.ReadCloser, error)

type Service

type Service struct {
	LOCCacher       LOCCacher // possibly nil
	ContentProvider ContentProvider
	// contains filtered or unexported fields
}

func New

func New(locCacher LOCCacher, contentProvider ContentProvider, maxParallelWork int) *Service

func (*Service) GetStat

func (s *Service) GetStat(ctx context.Context, user, repo, branch string, filter, matcher *string, noLOCProvider bool, tempStorage TempStorage) (*loc_count.StatTree, error)

type TempStorage

type TempStorage int

const (
	TempStorageFile TempStorage = iota
	TempStorageRam
)