filetree

Documentation

Index

• Variables
• type Node
  • func NewTree(rootPath string, allowedDirectories ...string) (*Node, error)
  • func (n Node) MarshalYAML() (interface{}, error)
• type PathNodes

Variables

var SpecialCase func(path string) bool

SpecialCase is a function you can pass to NewTree in order to override the behavior when marshalling a node.

Types

type Node

type Node struct {
	FullPath string      `json:"full_path"`
	Info     os.FileInfo `json:"-"`
	Children []*Node     `json:"-"`
	Parent   *Node       `json:"-"`
}

Node represents a leaf in the filetree

func NewTree

func NewTree(rootPath string, allowedDirectories ...string) (*Node, error)

NewTree creates a new filetree starting at the root

func (Node) MarshalYAML

func (n Node) MarshalYAML() (interface{}, error)

MarshalYAML serializes the tree into YAML

type PathNodes

type PathNodes struct {
	Map  map[string]*Node
	Keys []string
}

PathNodes is a map of filepaths to tree nodes with ordered path keys.