gojsonlex

Documentation

Index

• func IsDelim(c rune) bool
• func IsHexDigit(c rune) bool
• func IsValidEscapedSymbol(c rune) bool
• func StringDeepCopy(s string) string
• type JSONLexer
  • func NewJSONLexer(r io.Reader) (*JSONLexer, error)
  • func (l *JSONLexer) SetBufSize(bufSize int)
  • func (l *JSONLexer) SetDebug(debug bool)
  • func (l *JSONLexer) SetSkipDelims(mustSkip bool)
  • func (l *JSONLexer) Token() (json.Token, error)
  • func (l *JSONLexer) TokenFast() (TokenGeneric, error)
• type TokenGeneric
  • func (t *TokenGeneric) Bool() bool
  • func (t *TokenGeneric) Delim() byte
  • func (t *TokenGeneric) IsNull() bool
  • func (t *TokenGeneric) Number() float64
  • func (t *TokenGeneric) String() string
  • func (t *TokenGeneric) StringCopy() string
  • func (t *TokenGeneric) Type() TokenType
• type TokenType
  • func (t TokenType) String() string

Functions

func IsDelim

func IsDelim(c rune) bool

IsDelim reports whether the given rune is a JSON delimiter

func IsHexDigit

func IsHexDigit(c rune) bool

func IsValidEscapedSymbol

func IsValidEscapedSymbol(c rune) bool

func StringDeepCopy

func StringDeepCopy(s string) string

StringDeepCopy creates a copy of the given string with it's own underlying bytearray. Use this function to make a copy of string returned by Token()

Types

type JSONLexer

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

JSONLexer is a JSON lexical analyzer with streaming API support, where stream is a sequence of JSON tokens. JSONLexer does its own IO buffering so prefer low-level readers if you want to miminize memory footprint.

JSONLexer uses a ring buffer for parsing tokens, every token must fit in its size, otherwise buffer will be automatically grown. Initial size of buffer is 4096 bytes, however you can tweak it with SetBufSize() in case you know that most tokens are going to be long.

JSONLexer uses unsafe pointers into the underlying buf to minimize allocations, see Token() for the provided guarantees.

func NewJSONLexer

func NewJSONLexer(r io.Reader) (*JSONLexer, error)

NewJSONLexer creates a new JSONLexer with the given reader.

func (*JSONLexer) SetBufSize

func (l *JSONLexer) SetBufSize(bufSize int)

SetBufSize creates a new buffer of the given size. MUST be called before parsing started.

func (*JSONLexer) SetDebug

func (l *JSONLexer) SetDebug(debug bool)

SetDebug enables debug logging

func (*JSONLexer) SetSkipDelims

func (l *JSONLexer) SetSkipDelims(mustSkip bool)

SetSkipDelims tells JSONLexer to skip delimiters and return only keys and values. This can be useful in case you want to simply match the input to some specific grammar and have no intention of doing full syntax analysis.

func (*JSONLexer) Token

func (l *JSONLexer) Token() (json.Token, error)

Token returns the next JSON token. All strings returned by Token are guaranteed to be valid until the next Token call, otherwise you MUST make a deep copy.

func (*JSONLexer) TokenFast

func (l *JSONLexer) TokenFast() (TokenGeneric, error)

TokenFast is a more efficient version of Token(). All strings returned by Token are guaranteed to be valid until the next Token call, otherwise you MUST make a deep copy.

type TokenGeneric

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

func (*TokenGeneric) Bool

func (t *TokenGeneric) Bool() bool

func (*TokenGeneric) Delim

func (t *TokenGeneric) Delim() byte

func (*TokenGeneric) IsNull

func (t *TokenGeneric) IsNull() bool

func (*TokenGeneric) Number

func (t *TokenGeneric) Number() float64

func (*TokenGeneric) String

func (t *TokenGeneric) String() string

String returns string that points into internal lexer buffer and is guaranteed to be valid until the next Token call, otherwise you MUST make a deep copy

func (*TokenGeneric) StringCopy

func (t *TokenGeneric) StringCopy() string

StringCopy return a deep copy of string

func (*TokenGeneric) Type

func (t *TokenGeneric) Type() TokenType

type TokenType

type TokenType byte

const (
	LexerTokenTypeDelim TokenType = iota
	LexerTokenTypeString
	LexerTokenTypeNumber
	LexerTokenTypeBool
	LexerTokenTypeNull
)

func (TokenType) String

func (t TokenType) String() string