ls_tree

Documentation

Index

• type LsTreeEntry
• type LsTreeOptions
  • func (opts LsTreeOptions) ID() string
• type Result
  • func LsTree(ctx context.Context, repoHandle repo_handle.Handle, commit string, ...) (*Result, error)
  • func NewResult(commit string, repositoryFullFilepath string, lsTreeEntries []*LsTreeEntry, ...) *Result
  • func (r *Result) Checksum(ctx context.Context) string
  • func (r *Result) IsEmpty() bool
  • func (r *Result) LsTree(ctx context.Context, repoHandle repo_handle.Handle, opts LsTreeOptions) (*Result, error)
  • func (r *Result) LsTreeEntry(relPath string) *LsTreeEntry
  • func (r *Result) LsTreeEntryContent(mainRepoHandle repo_handle.Handle, relPath string) ([]byte, error)
  • func (r *Result) Walk(f func(lsTreeEntry *LsTreeEntry) error) error
• type SubmoduleResult
  • func NewSubmoduleResult(submoduleName, submodulePath string, result *Result) *SubmoduleResult

Types

type LsTreeEntry

type LsTreeEntry struct {
	FullFilepath string
	object.TreeEntry
}

type LsTreeOptions

type LsTreeOptions struct {
	// the PathScope option determines the directory or file that will get into the result (similar to <pathspec> in the git commands)
	PathScope   string
	PathMatcher path_matcher.PathMatcher
	AllFiles    bool
}

func (LsTreeOptions) ID

func (opts LsTreeOptions) ID() string

type Result

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

func LsTree

func LsTree(ctx context.Context, repoHandle repo_handle.Handle, commit string, opts LsTreeOptions) (*Result, error)

LsTree returns the Result with tree entries that satisfy the passed options. The function works lazily and does not go through a tree directory unnecessarily. If the result should contain only regular files (without directories and submodules), you should use the AllFiles option.

func NewResult

func NewResult(commit string, repositoryFullFilepath string, lsTreeEntries []*LsTreeEntry, submodulesResults []*SubmoduleResult) *Result

func (*Result) Checksum

func (r *Result) Checksum(ctx context.Context) string

func (*Result) IsEmpty

func (r *Result) IsEmpty() bool

func (*Result) LsTree

func (r *Result) LsTree(ctx context.Context, repoHandle repo_handle.Handle, opts LsTreeOptions) (*Result, error)

func (*Result) LsTreeEntry

func (r *Result) LsTreeEntry(relPath string) *LsTreeEntry

func (*Result) LsTreeEntryContent

func (r *Result) LsTreeEntryContent(mainRepoHandle repo_handle.Handle, relPath string) ([]byte, error)

func (*Result) Walk

func (r *Result) Walk(f func(lsTreeEntry *LsTreeEntry) error) error

type SubmoduleResult

type SubmoduleResult struct {
	*Result
	// contains filtered or unexported fields
}

func NewSubmoduleResult

func NewSubmoduleResult(submoduleName, submodulePath string, result *Result) *SubmoduleResult