icvcn

package

v1.12.0 Latest Latest Go to latest Published: Dec 19, 2025 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gnames/gnparser

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Pretty(pretty bool) func(*Parser) error
func Size(size int) func(*Parser) error
type Parsed
- func Parse(inp string) *Parsed
- func (p *Parsed) ToOutput(withDetails, _ bool) parsed.Parsed
type Parser
type Rank
- func (r Rank) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var RankToStr = map[Rank]string{
	Realm:      "Realm",
	Subrealm:   "Subrealm",
	Kingdom:    "Kingdom",
	Subkingdom: "Subkingdom",
	Phylum:     "Phylum",
	Subphylum:  "Subphylum",
	Class:      "Class",
	Subclass:   "Subclass",
	Order:      "Order",
	Suborder:   "Suborder",
	Family:     "Family",
	Subfamily:  "Subfamily",
	Genus:      "Genus",
	Species:    "Species",
}

Functions ¶

func Pretty ¶

func Pretty(pretty bool) func(*Parser) error

func Size ¶

func Size(size int) func(*Parser) error

Types ¶

type Parsed ¶

type Parsed struct {
	Input         string
	Rank          Rank
	Uninomial     string
	Genus         string
	Species       string
	Words         []parsed.Word
	Error         error
	Parsed        bool
	ParserVersion string
}

func Parse ¶

func Parse(inp string) *Parsed

func (*Parsed) ToOutput ¶

func (p *Parsed) ToOutput(withDetails, _ bool) parsed.Parsed

type Parser ¶

type Parser struct {
	Buffer string

	Pretty bool
	// contains filtered or unexported fields
}

func (*Parser) AST ¶

func (t *Parser) AST() *node32

func (*Parser) Add ¶

func (t *Parser) Add(rule pegRule, begin, end, index uint32)

func (*Parser) Init ¶

func (p *Parser) Init(options ...func(*Parser) error) error

func (*Parser) Parse ¶

func (p *Parser) Parse(rule ...int) error

func (*Parser) ParseToStruct ¶

func (p *Parser) ParseToStruct() Parsed

ParseToStruct parses the input and returns a ParsedICVCN structure. If parsing fails, the Error field will contain the error and Parsed will be false.

func (*Parser) PrettyPrintSyntaxTree ¶

func (t *Parser) PrettyPrintSyntaxTree(buffer string)

func (*Parser) Print ¶

func (t *Parser) Print()

func (*Parser) PrintSyntaxTree ¶

func (p *Parser) PrintSyntaxTree()

func (*Parser) Reset ¶

func (p *Parser) Reset()

func (*Parser) SprintSyntaxTree ¶

func (p *Parser) SprintSyntaxTree() string

func (*Parser) Tokens ¶

func (t *Parser) Tokens() []token32

func (*Parser) Trim ¶

func (t *Parser) Trim(length uint32)

func (*Parser) WriteSyntaxTree ¶

func (p *Parser) WriteSyntaxTree(w io.Writer)

type Rank ¶

type Rank int

const (
	UnknownRank Rank = iota
	Realm
	Subrealm
	Kingdom
	Subkingdom
	Phylum
	Subphylum
	Class
	Subclass
	Order
	Suborder
	Family
	Subfamily
	Genus
	Species
)

func (Rank) String ¶

func (r Rank) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL