walker

Documentation

Index

• Constants
• func IsFatalErr(err error) bool
• type Error
  • func (e Error) Error() string
• type Mark
• type Reader
  • func New(r TokenReader) *Reader
  • func (w *Reader) Commit(m *Mark) error
  • func (w *Reader) CommitAll()
  • func (w *Reader) Discard(m *Mark) error
  • func (w *Reader) DiscardAll()
  • func (w *Reader) GoString() string
  • func (w *Reader) LastToken() (leks.Token, error)
  • func (w *Reader) Mark() *Mark
  • func (w *Reader) PeekToken() (tok leks.Token, err error)
  • func (w *Reader) ReadToken() (tok leks.Token, err error)
  • func (w *Reader) Reset(m *Mark) error
• type TokenReader

Constants

const (

	// ErrBadWalkerState may be returned by a method when the reader wasn't allocated with walker.New.
	ErrBadWalkerState = Error(iota) // invalid reader state
	ErrInvalidRead                  // last op was not ReadToken

	ErrMarkNil       // mark is nil
	ErrMarkUnderflow // mark depth underflow
	ErrNoMarks       // walker has no marks
	ErrMarkNotFound  // mark not found
)

Functions

func IsFatalErr

func IsFatalErr(err error) bool

Types

type Error

type Error int

Error is any error returned by a Reader.

func (Error) Error

func (e Error) Error() string

type Mark

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

type Reader

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

func New

func New(r TokenReader) *Reader

func (*Reader) Commit

func (w *Reader) Commit(m *Mark) error

func (*Reader) CommitAll

func (w *Reader) CommitAll()

func (*Reader) Discard

func (w *Reader) Discard(m *Mark) error

func (*Reader) DiscardAll

func (w *Reader) DiscardAll()

func (*Reader) GoString

func (w *Reader) GoString() string

GoString implements GoStringer. This is a more or less debug-heavy way to get walker state, so avoid using it unless you're debugging.

func (*Reader) LastToken

func (w *Reader) LastToken() (leks.Token, error)

func (*Reader) Mark

func (w *Reader) Mark() *Mark

func (*Reader) PeekToken

func (w *Reader) PeekToken() (tok leks.Token, err error)

func (*Reader) ReadToken

func (w *Reader) ReadToken() (tok leks.Token, err error)

func (*Reader) Reset

func (w *Reader) Reset(m *Mark) error

type TokenReader

type TokenReader interface {
	ReadToken() (leks.Token, error)
}