package text

Import Path
	google.golang.org/protobuf/internal/encoding/text (on go.dev)

Dependency Relation
	imports 14 packages, and imported by 2 packages

Involved Source Files

	    decode.go
	    decode_number.go
	    decode_string.go
	    decode_token.go
	  d doc.go
		Package text implements the text format for protocol buffers.
		This package has no semantic understanding for protocol buffers and is only
		a parser and composer for the format.
		
		There is no formal specification for the protobuf text format, as such the
		C++ implementation (see google::protobuf::TextFormat) is the reference
		implementation of the text format.
		
		This package is neither a superset nor a subset of the C++ implementation.
		This implementation permits a more liberal grammar in some cases to be
		backwards compatible with the historical Go implementation.
		Future parsings unique to Go should not be added.
		Some grammars allowed by the C++ implementation are deliberately
		not implemented here because they are considered a bug by the protobuf team
		and should not be replicated.
		
		The Go implementation should implement a sufficient amount of the C++
		grammar such that the default text serialization by C++ can be parsed by Go.
		However, just because the C++ parser accepts some input does not mean that
		the Go implementation should as well.
		
		The text format is almost a superset of JSON except:
		  - message keys are not quoted strings, but identifiers
		  - the top-level value must be a message without the delimiters

	    encode.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Decoder (struct)
		Decoder is a token-based textproto decoder.

		Methods (total 3)
			(*Decoder) Peek() (Token, error)
				Peek looks ahead and returns the next token and error without advancing a read.

			(*Decoder) Position(idx int) (line int, column int)
				Position returns line and column number of given index of the original input.
				It will panic if index is out of range.

			(*Decoder) Read() (Token, error)
				Read returns the next token.
				It will return an error if there is no valid token.

		As Outputs Of (at least one exported)
			func NewDecoder(b []byte) *Decoder

	 type Encoder (struct)
		Encoder provides methods to write out textproto constructs and values. The user is
		responsible for producing valid sequences of constructs and values.

		Methods (total 12)
			(*Encoder) Bytes() []byte
				Bytes returns the content of the written bytes.

			(*Encoder) EndMessage()
				EndMessage writes out the '}' or '>' symbol.

			(*Encoder) Reset(es encoderState)
				Reset resets the Encoder to the given encoderState from a Snapshot.

			(*Encoder) Snapshot() encoderState
				Snapshot returns the current snapshot for use in Reset.

			(*Encoder) StartMessage()
				StartMessage writes out the '{' or '<' symbol.

			(*Encoder) WriteBool(b bool)
				WriteBool writes out the given boolean value.

			(*Encoder) WriteFloat(n float64, bitSize int)
				WriteFloat writes out the given float value for given bitSize.

			(*Encoder) WriteInt(n int64)
				WriteInt writes out the given signed integer value.

			(*Encoder) WriteLiteral(s string)
				WriteLiteral writes out the given string as a literal value without quotes.
				This is used for writing enum literal strings.

			(*Encoder) WriteName(s string)
				WriteName writes out the field name and the separator ':'.

			(*Encoder) WriteString(s string)
				WriteString writes out the given string value.

			(*Encoder) WriteUint(n uint64)
				WriteUint writes out the given unsigned integer value.

		Implements (at least one exported)
			*Encoder : github.com/apache/arrow-go/v18/internal/hashing.ByteSlice
		As Outputs Of (at least one exported)
			func NewEncoder(buf []byte, indent string, delims [2]byte, outputASCII bool) (*Encoder, error)

	 type Kind uint8 (basic type)
		Kind represents a token kind expressible in the textproto format.

		Methods (only one)
			( Kind) String() string
		Implements (at least 2)
			 Kind : expvar.Var
			 Kind : fmt.Stringer
		As Outputs Of (at least one exported)
			func Token.Kind() Kind
		As Types Of (total 8)
			const EOF
			const Invalid
			const ListClose
			const ListOpen
			const MessageClose
			const MessageOpen
			const Name
			const Scalar

	 type NameKind uint8 (basic type)
		NameKind represents different types of field names.

		Methods (only one)
			( NameKind) String() string
		Implements (at least 2)
			 NameKind : expvar.Var
			 NameKind : fmt.Stringer
		As Outputs Of (at least one exported)
			func Token.NameKind() NameKind
		As Types Of (total 3)
			const FieldNumber
			const IdentName
			const TypeName

	 type Token (struct)
		Token provides a parsed token kind and value. Values are provided by the
		different accessor methods.

		Methods (total 17)
			( Token) Bool() (bool, bool)
				Bool returns the bool value for a Scalar type.

			( Token) Enum() (string, bool)
				Enum returns the literal value for a Scalar type for use as enum literals.

			( Token) FieldNumber() int32
				FieldNumber returns the value for FieldNumber type. It returns a
				non-negative int32 value. Caller will still need to validate for the correct
				field number range.

			( Token) Float32() (float32, bool)
				Float32 returns the float32 value for a Scalar type.

			( Token) Float64() (float64, bool)
				Float64 returns the float64 value for a Scalar type.

			( Token) HasSeparator() bool
				HasSeparator returns true if the field name is followed by the separator char
				':', else false. It panics if type is not Name.

			( Token) IdentName() string
				IdentName returns the value for IdentName type.

			( Token) Int32() (int32, bool)
				Int32 returns the int32 value for a Scalar type.

			( Token) Int64() (int64, bool)
				Int64 returns the int64 value for a Scalar type.

			( Token) Kind() Kind
				Kind returns the token kind.

			( Token) NameKind() NameKind
				NameKind returns IdentName, TypeName or FieldNumber.
				It panics if type is not Name.

			( Token) Pos() int
				Pos returns the token position from the input.

			( Token) RawString() string
				RawString returns the read value in string.

			( Token) String() (string, bool)
				String returns the string value for a Scalar type.

			( Token) TypeName() string
				TypeName returns the value for TypeName type.

			( Token) Uint32() (uint32, bool)
				Uint32 returns the uint32 value for a Scalar type.

			( Token) Uint64() (uint64, bool)
				Uint64 returns the uint64 value for a Scalar type.

		Implements (at least one exported)
			 Token : github.com/apache/arrow-go/v18/arrow/compute.FunctionOptions
		As Outputs Of (at least 2)
			func (*Decoder).Peek() (Token, error)
			func (*Decoder).Read() (Token, error)
		As Inputs Of (at least one exported)
			func TokenEquals(x, y Token) bool


Package-Level Functions (total 5)

	 func AppendString(b []byte, s string) []byte
		AppendString appends the escaped form of the input string to b.

	 func NewDecoder(b []byte) *Decoder
		NewDecoder returns a Decoder to read the given []byte.

	 func NewEncoder(buf []byte, indent string, delims [2]byte, outputASCII bool) (*Encoder, error)
		NewEncoder returns an Encoder.
		
		If indent is a non-empty string, it causes every entry in a List or Message
		to be preceded by the indent and trailed by a newline.
		
		If delims is not the zero value, it controls the delimiter characters used
		for messages (e.g., "{}" vs "<>").
		
		If outputASCII is true, strings will be serialized in such a way that
		multi-byte UTF-8 sequences are escaped. This property ensures that the
		overall output is ASCII (as opposed to UTF-8).

	 func TokenEquals(x, y Token) bool
		TokenEquals returns true if given Tokens are equal, else false.

	 func UnmarshalString(s string) (string, error)
		UnmarshalString returns an unescaped string given a textproto string value.
		String value needs to contain single or double quotes. This is only used by
		internal/encoding/defval package for unmarshaling bytes.


Package-Level Variables (only one)

	  var ErrUnexpectedEOF error
		ErrUnexpectedEOF means that EOF was encountered in the middle of the input.


Package-Level Constants (total 11)

	const EOF Kind = 1
		Kind values.

	const FieldNumber NameKind = 3
		NameKind values.

	const IdentName NameKind = 1
		NameKind values.

	const Invalid Kind = 0
		Kind values.

	const ListClose Kind = 7
		Kind values.

	const ListOpen Kind = 6
		Kind values.

	const MessageClose Kind = 5
		Kind values.

	const MessageOpen Kind = 4
		Kind values.

	const Name Kind = 2 // Name indicates the field name.
		Kind values.

	const Scalar Kind = 3 // Scalar are scalar values, e.g. "string", 47, ENUM_LITERAL, true.
		Kind values.

	const TypeName NameKind = 2
		NameKind values.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.