wiki

package
v0.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2022 License: AGPL-3.0, AGPL-3.0-only Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrWikiSyntax         = errors.New("invalid wiki syntax")
	ErrArrayNoClose       = fmt.Errorf("array should be closed by '}': %w", ErrWikiSyntax)
	ErrArrayItemWrapped   = fmt.Errorf("array item should be wrapped by '[]': %w", ErrWikiSyntax)
	ErrExpectingNewField  = fmt.Errorf("expecting '|' to start a new field: %w", ErrWikiSyntax)
	ErrExpectingSignEqual = fmt.Errorf("expecting '=' to seprate field name and value: %w", ErrWikiSyntax) //nolint:lll
)

Functions

This section is empty.

Types

type Field 

type Field struct {
	Key    string `json:"key"`
	Value  string `json:"value"`
	Values []Item `json:"values"`
	Array  bool   `json:"array"`
	Null   bool   `json:"null,omitempty"`
}

type Item 

type Item struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Wiki 

type Wiki struct {
	Type   string  `json:"type"`
	Fields []Field `json:"fields"`
}

func Parse 

func Parse(s string) (Wiki, error)

func ParseOmitError 

func ParseOmitError(s string) Wiki

ParseOmitError try to parse a string as wiki, omitting error.

func (Wiki) Strip 

func (w Wiki) Strip() Wiki

Strip return a wiki without empty fields and items.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.