ast

Documentation

Index

• type BaseBlock
• type BaseInline
• type BaseNode
  • func (n *BaseNode) NextSibling() Node
  • func (n *BaseNode) PrevSibling() Node
  • func (n *BaseNode) SetNextSibling(node Node)
  • func (n *BaseNode) SetPrevSibling(node Node)
• type Blockquote
  • func (*Blockquote) Type() NodeType
• type Bold
  • func (*Bold) Type() NodeType
• type BoldItalic
  • func (*BoldItalic) Type() NodeType
• type Code
  • func (*Code) Type() NodeType
• type CodeBlock
  • func (*CodeBlock) Type() NodeType
• type Heading
  • func (*Heading) Type() NodeType
• type HorizontalRule
  • func (*HorizontalRule) Type() NodeType
• type Image
  • func (*Image) Type() NodeType
• type Italic
  • func (*Italic) Type() NodeType
• type LineBreak
  • func (*LineBreak) Type() NodeType
• type Link
  • func (*Link) Type() NodeType
• type Node
• type NodeType
• type Paragraph
  • func (*Paragraph) Type() NodeType
• type Strikethrough
  • func (*Strikethrough) Type() NodeType
• type Tag
  • func (*Tag) Type() NodeType
• type Text
  • func (*Text) Type() NodeType

Types

type BaseBlock

type BaseBlock struct {
	BaseNode
}

type BaseInline

type BaseInline struct {
	BaseNode
}

type BaseNode

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

func (*BaseNode) NextSibling

func (n *BaseNode) NextSibling() Node

func (*BaseNode) PrevSibling

func (n *BaseNode) PrevSibling() Node

func (*BaseNode) SetNextSibling

func (n *BaseNode) SetNextSibling(node Node)

func (*BaseNode) SetPrevSibling

func (n *BaseNode) SetPrevSibling(node Node)

type Blockquote

type Blockquote struct {
	BaseBlock

	Children []Node
}

func (*Blockquote) Type

func (*Blockquote) Type() NodeType

type Bold

type Bold struct {
	BaseInline

	// Symbol is "*" or "_".
	Symbol  string
	Content string
}

func (*Bold) Type

func (*Bold) Type() NodeType

type BoldItalic

type BoldItalic struct {
	BaseInline

	// Symbol is "*" or "_".
	Symbol  string
	Content string
}

func (*BoldItalic) Type

func (*BoldItalic) Type() NodeType

type Code

type Code struct {
	BaseInline

	Content string
}

func (*Code) Type

func (*Code) Type() NodeType

type CodeBlock

type CodeBlock struct {
	BaseBlock

	Language string
	Content  string
}

func (*CodeBlock) Type

func (*CodeBlock) Type() NodeType

type Heading

type Heading struct {
	BaseBlock

	Level    int
	Children []Node
}

func (*Heading) Type

func (*Heading) Type() NodeType

type HorizontalRule

type HorizontalRule struct {
	BaseBlock

	// Symbol is "*" or "-" or "_".
	Symbol string
}

func (*HorizontalRule) Type

func (*HorizontalRule) Type() NodeType

type Image

type Image struct {
	BaseInline

	AltText string
	URL     string
}

func (*Image) Type

func (*Image) Type() NodeType

type Italic

type Italic struct {
	BaseInline

	// Symbol is "*" or "_".
	Symbol  string
	Content string
}

func (*Italic) Type

func (*Italic) Type() NodeType

type LineBreak

type LineBreak struct {
	BaseBlock
}

func (*LineBreak) Type

func (*LineBreak) Type() NodeType

type Link

type Link struct {
	BaseInline

	Text string
	URL  string
}

func (*Link) Type

func (*Link) Type() NodeType

type Node

type Node interface {
	// Type returns a node type.
	Type() NodeType

	// PrevSibling returns a previous sibling node of this node.
	PrevSibling() Node

	// NextSibling returns a next sibling node of this node.
	NextSibling() Node

	// SetPrevSibling sets a previous sibling node to this node.
	SetPrevSibling(Node)

	// SetNextSibling sets a next sibling node to this node.
	SetNextSibling(Node)
}

type NodeType

type NodeType uint32

const (
	UnknownNode NodeType = iota
	// Block nodes.
	LineBreakNode
	ParagraphNode
	CodeBlockNode
	HeadingNode
	HorizontalRuleNode
	BlockquoteNode
	// Inline nodes.
	TextNode
	BoldNode
	ItalicNode
	BoldItalicNode
	CodeNode
	ImageNode
	LinkNode
	TagNode
	StrikethroughNode
)

type Paragraph

type Paragraph struct {
	BaseBlock

	Children []Node
}

func (*Paragraph) Type

func (*Paragraph) Type() NodeType

type Strikethrough

type Strikethrough struct {
	BaseInline

	Content string
}

func (*Strikethrough) Type

func (*Strikethrough) Type() NodeType

type Tag

type Tag struct {
	BaseInline

	Content string
}

func (*Tag) Type

func (*Tag) Type() NodeType

type Text

type Text struct {
	BaseInline

	Content string
}

func (*Text) Type

func (*Text) Type() NodeType