parse

Documentation

Index

• type ComprehensiveRules
  • func ParseCR(r io.Reader) ComprehensiveRules
• type Rule
  • func NewRule(title string) *Rule
  • func (r *Rule) CompleteText() string
  • func (r *Rule) Text() string
• type Title
  • func (t Title) Depth() int
  • func (t Title) Name() string
  • func (t Title) ParentTitle() Title

Types

type ComprehensiveRules

type ComprehensiveRules map[Title]*Rule

func ParseCR

func ParseCR(r io.Reader) ComprehensiveRules

type Rule

type Rule struct {
	Title
	Body     string   `json:",omitempty"`
	Notes    []string `json:",omitempty"`
	Examples []string `json:",omitempty"`
	Parent   *Rule    `json:"-"`
	Children []*Rule  `json:",omitempty"`
}

func NewRule

func NewRule(title string) *Rule

func (*Rule) CompleteText

func (r *Rule) CompleteText() string

func (*Rule) Text

func (r *Rule) Text() string

type Title

type Title string

func (Title) Depth

func (t Title) Depth() int

func (Title) Name

func (t Title) Name() string

func (Title) ParentTitle

func (t Title) ParentTitle() Title