internal

Documentation

Overview

Copyright (c) 2021 Uber Technologies, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• func Parse(s []byte) (ParseResult, []ParseError)
• func ParseDocstring(s string) string
• func UnquoteDoubleQuoted(in []byte) (string, error)
• func UnquoteSingleQuoted(in []byte) (string, error)
• type NodePositions
• type ParseError
• type ParseResult

Constants

const BINARY = 57362

const BOOL = 57354

const BYTE = 57355

const CONST = 57375

const CPP_INCLUDE = 57352

const DOUBLE = 57360

const DUBCONSTANT = 57349

const ENUM = 57374

const EXCEPTION = 57370

const EXTENDS = 57371

const FALSE = 57379

const I16 = 57357

const I32 = 57358

const I64 = 57359

const I8 = 57356

const IDENTIFIER = 57346

const INCLUDE = 57351

const INTCONSTANT = 57348

const LIST = 57364

const LITERAL = 57347

const MAP = 57363

const NAMESPACE = 57350

const ONEWAY = 57366

const OPTIONAL = 57377

const REQUIRED = 57376

const SERVICE = 57373

const SET = 57365

const STRING = 57361

const STRUCT = 57368

const THROWS = 57372

const TRUE = 57378

const TYPEDEF = 57367

const UNION = 57369

const VOID = 57353

Functions

func Parse

func Parse(s []byte) (ParseResult, []ParseError)

Parse parses the given Thrift document.

func ParseDocstring

func ParseDocstring(s string) string

ParseDocstring takes a docstring in the form,

/**
 * foo bar
 */

And returns,

foo bar

func UnquoteDoubleQuoted

func UnquoteDoubleQuoted(in []byte) (string, error)

UnquoteDoubleQuoted unquotes a slice of bytes representing a double quoted string.

UnquoteDoubleQuoted([]byte("\"foo\"")) == "foo"

func UnquoteSingleQuoted

func UnquoteSingleQuoted(in []byte) (string, error)

UnquoteSingleQuoted unquotes a slice of bytes representing a single quoted string.

UnquoteSingleQuoted([]byte("'foo'")) == "foo"

Types

type NodePositions

type NodePositions map[ast.Node]ast.Position

NodePositions maps (hashable) nodes to their document positions.

type ParseError

type ParseError struct {
	Pos ast.Position
	Err error
}

ParseError holds a parse error and the position that caused it.

type ParseResult

type ParseResult struct {
	Program       *ast.Program
	NodePositions NodePositions
}

ParseResult holds the result of a successful Parse.