ptree

Documentation

Index

• Constants
• func Write(w io.Writer, root Node, config *Config) error
• type Config
  • func DefaultConfig(tb bool) *Config
• type Node

Constants

const (
	DefaultBar          = '│'
	DefaultFirstNode    = '├'
	DefaultBranchNode   = '├'
	DefaultBranchNodeTB = '┬'
	DefaultLastNode     = '└'
	DefaultLastNodeTB   = '┐'
	DefaultDash         = '─'
	DefaultFill         = ' '
	DefaultWidth        = 4
)

Default markers.

Functions

func Write

func Write(w io.Writer, root Node, config *Config) error

Types

type Config

type Config struct {
	Bar        rune // Marks downward no-branching connections.
	FirstNode  rune // Marks branches to the first child node.
	BranchNode rune // Marks branches to middle child nodes.
	LastNode   rune // Marks branches to the last child node.
	Dash       rune // Marks righward connections.
	Fill       rune // Marks the filler string.
	Width      int  // Gives the width.
	TB         bool // Print tree top to bottom.
}

func DefaultConfig

func DefaultConfig(tb bool) *Config

type Node

type Node interface {
	fmt.Stringer      // Name of the node.
	Children() []Node // List of the node's children.
}

Basic interface for tree views.