strparse

Documentation

Overview

package strparse provides a string parser and utilities.

Index

• func Digit1() parser.Parser[rune, string]
• func Rune(expected rune) parser.Parser[rune, rune]
• func Tag(tag string) parser.Parser[rune, string]
• type CompleteInput
  • func NewCompleteInput(s string) *CompleteInput
  • func (c *CompleteInput) Read(buf []rune) (int, error)
  • func (c *CompleteInput) Seek(n int, mode parser.SeekMode) (int, error)
• type UnexpectedPrefixError
  • func (e *UnexpectedPrefixError) Error() string
• type UnexpectedRuneError
  • func (e *UnexpectedRuneError) Error() string

Examples

• Digit1
• Rune
• Tag

Functions

func Digit1

func Digit1() parser.Parser[rune, string]

Digit1 initializes a parser that follows (0-9)+ syntax rule.

Example

package main

import (
	"fmt"

	"github.com/Drumato/peachcomb/pkg/strparse"
)

func main() {
	i := strparse.NewCompleteInput("112233abc")
	_, o, err := strparse.Digit1()(i)
	fmt.Println(o)
	fmt.Println(err)
}

Output:


112233
<nil>

func Rune

func Rune(expected rune) parser.Parser[rune, rune]

Rune initializes a parser that consumes one rune. It's just a specialized parser from combinator.Satisfy().

Example

package main

import (
	"fmt"

	"github.com/Drumato/peachcomb/pkg/strparse"
)

func main() {
	i := strparse.NewCompleteInput("abc")
	_, o, err := strparse.Rune('a')(i)
	fmt.Printf("%c\n", o)
	fmt.Println(err)
}

Output:


a
<nil>

func Tag

func Tag(tag string) parser.Parser[rune, string]

Tag initializes a parser that checks the input starts with the tag prefix.

Example

package main

import (
	"fmt"

	"github.com/Drumato/peachcomb/pkg/strparse"
)

func main() {
	i := strparse.NewCompleteInput("Drumato")
	_, o, err := strparse.Tag("Drum")(i)
	fmt.Println(o)
	fmt.Println(err)
}

Output:


Drum
<nil>

Types

type CompleteInput

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

CompleteInput holds the whole runes.

func NewCompleteInput

func NewCompleteInput(s string) *CompleteInput

NewCompleteInput initialiizes a CompleteInput.

func (*CompleteInput) Read

func (c *CompleteInput) Read(buf []rune) (int, error)

Read implements parser.ParseInput interface.

func (*CompleteInput) Seek

func (c *CompleteInput) Seek(n int, mode parser.SeekMode) (int, error)

Seek implements parser.ParseInput interface.

type UnexpectedPrefixError

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

UnexpectedPrefixError notifies the prefix of the given input is unexpected.

func (*UnexpectedPrefixError) Error

func (e *UnexpectedPrefixError) Error() string

Error implements error interface.

type UnexpectedRuneError

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

UnexpectedRuneError notifies the head of the given input is unexpected.

func (*UnexpectedRuneError) Error

func (e *UnexpectedRuneError) Error() string

Error implements error interface.