help

Documentation

Index

• Variables
• func FormatClamp(head, tail string) func(string) string
• func FormatHeader(head string) func(string) string
• func FormatNone(raw string) string
• type Distance
  • func NewDistance() Distance
  • func (distance *Distance) ChildOffseth() int
  • func (distance *Distance) MaxKeyLength() int
  • func (distance *Distance) MaxValueTypeLength() int
  • func (distance *Distance) TipOffset() int
  • func (distance *Distance) UpdateTip(name, kind string)
• type Section
  • func NewSection(name string, usetip string, distance *Distance) *Section
  • func (section *Section) AddSection(newSection *Section)
  • func (section *Section) AddTip(name, kind, tips, value string)
  • func (section *Section) PrintSection(w io.Writer, format func(string) string)
  • func (section *Section) PrintSectionWithOffset(w io.Writer, offset int, format func(string) string)
• type Tip
  • func (tip Tip) Fprint(w io.Writer, offset int, keyLength int, typeLength int)

Variables

var (
	DefaultChildOffset int    = 4
	DefaultTipOffset   int    = 4 //
	DefaultValueType   string = "unknown"
	DefaultSortPrint   bool   = true
)

Functions

func FormatClamp

func FormatClamp(head, tail string) func(string) string

func FormatHeader

func FormatHeader(head string) func(string) string

func FormatNone

func FormatNone(raw string) string

Types

type Distance

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

func NewDistance

func NewDistance() Distance

func (*Distance) ChildOffseth

func (distance *Distance) ChildOffseth() int

func (*Distance) MaxKeyLength

func (distance *Distance) MaxKeyLength() int

func (*Distance) MaxValueTypeLength

func (distance *Distance) MaxValueTypeLength() int

func (*Distance) TipOffset

func (distance *Distance) TipOffset() int

func (*Distance) UpdateTip

func (distance *Distance) UpdateTip(name, kind string)

type Section

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

func NewSection

func NewSection(name string, usetip string, distance *Distance) *Section

func (*Section) AddSection

func (section *Section) AddSection(newSection *Section)

func (*Section) AddTip

func (section *Section) AddTip(name, kind, tips, value string)

func (*Section) PrintSection

func (section *Section) PrintSection(w io.Writer, format func(string) string)

func (*Section) PrintSectionWithOffset

func (section *Section) PrintSectionWithOffset(w io.Writer, offset int, format func(string) string)

type Tip

type Tip struct {
	Name         string
	ValueType    string
	TipStr       string
	DefaultValue string
}

func (Tip) Fprint

func (tip Tip) Fprint(w io.Writer, offset int, keyLength int, typeLength int)