Package: github.com/hashicorp/hcl/json/scanner

package scanner Import Path github.com/hashicorp/hcl/json/scanner (on go.dev) Dependency Relation imports 6 packages, and imported by one package

Involved Source Files scanner.go

Package-Level Type Names (only one, which is exported)

/* sort exporteds by: alphabet | popularity */

type Scanner (struct) Scanner defines a lexical scanner Fields (total 11, in which 2 are exported) Error func(pos token.Pos, msg string) Error is called for each error encountered. If no Error function is set, the error is reported to os.Stderr. ErrorCount int ErrorCount is incremented by one for each error encountered. /* 9 unexporteds ... *//* 9 unexporteds: */ buf *bytes.Buffer // Source buffer for advancing and scanning lastCharLen int // length of last character in bytes lastLineLen int // length of last line in characters (for correct column reporting) prevPos token.Pos // previous position, used for peek() method src []byte // Source buffer for immutable access srcPos token.Pos Source Position // current position tokEnd int // token text end position tokPos token.Pos tokPos is the start position of most recently scanned token; set by Scan. The Filename field is always left untouched by the Scanner. If an error is reported (via Error) and Position is invalid, the scanner is not inside a token. tokStart int // token text start position Methods (total 14, in which 1 are exported) (*T) Scan() token.Token Scan scans the next token and returns the token. /* 13 unexporteds ... *//* 13 unexporteds: */ (*T) err(msg string) err prints the error of any scanning to s.Error function. If the function is not defined, by default it prints them to os.Stderr (*T) next() rune next reads the next rune from the bufferred reader. Returns the rune(0) if an error occurs (or io.EOF is returned). (*T) peek() rune peek returns the next rune without advancing the reader. (*T) recentPosition() (pos token.Pos) recentPosition returns the position of the character immediately after the character or token returned by the last call to Scan. (*T) scanDigits(ch rune, base, n int) rune scanDigits scans a rune with the given base for n times. For example an octal notation \184 would yield in scanDigits(ch, 8, 3) (*T) scanEscape() rune scanEscape scans an escape sequence (*T) scanExponent(ch rune) rune scanExponent scans the remaining parts of an exponent after the 'e' or 'E' rune. (*T) scanFraction(ch rune) rune scanFraction scans the fraction after the '.' rune (*T) scanIdentifier() string scanIdentifier scans an identifier and returns the literal string (*T) scanMantissa(ch rune) rune scanMantissa scans the mantissa beginning from the rune. It returns the next non decimal rune. It's used to determine wheter it's a fraction or exponent. (*T) scanNumber(ch rune) token.Type scanNumber scans a HCL number definition starting with the given rune (*T) scanString() scanString scans a quoted string (*T) unread() unread unreads the previous read Rune and updates the source position As Outputs Of (at least one exported) func New(src []byte) *Scanner

Package-Level Functions (total 7, in which 1 are exported)

func New(src []byte) *Scanner New creates and initializes a new instance of Scanner using src as its source content.

/* 6 unexporteds ... *//* 6 unexporteds: */

func digitVal(ch rune) int digitVal returns the integer value of a given octal,decimal or hexadecimal rune

func isDecimal(ch rune) bool isHexadecimal returns true if the given rune is a decimal number

func isDigit(ch rune) bool isHexadecimal returns true if the given rune is a decimal digit

func isHexadecimal(ch rune) bool isHexadecimal returns true if the given rune is an hexadecimal number

func isLetter(ch rune) bool isHexadecimal returns true if the given rune is a letter

func isWhitespace(ch rune) bool isWhitespace returns true if the rune is a space, tab, newline or carriage return

Package-Level Constants (only one, which is unexported) /* one unexported ... *//* one unexported: */

const eof rune = 0 eof represents a marker rune for the end of the reader.