package thrift

Import Path
	github.com/parquet-go/parquet-go/encoding/thrift (on go.dev)

Dependency Relation
	imports 15 packages, and imported by one package

Involved Source Files

	    binary.go
	    compact.go
	    debug.go
	    decode.go
	    encode.go
	    error.go
	    protocol.go
	    struct.go
	    thrift.go
	    unsafe.go
Package-Level Type Names (total 17)

	/* sort by: alphabet | popularity */
	 type BinaryProtocol (struct)
		BinaryProtocol is a Protocol implementation for the binary thrift protocol.
		
		https://github.com/apache/thrift/blob/master/doc/specs/thrift-binary-protocol.md

		Fields (only one)
			NonStrict bool
		Methods (total 3)
			(*BinaryProtocol) Features() Features
			(*BinaryProtocol) NewReader(r io.Reader) Reader
			(*BinaryProtocol) NewWriter(w io.Writer) Writer
		Implements (at least one exported)
			*BinaryProtocol : Protocol

	 type CompactProtocol (struct)
		CompactProtocol is a Protocol implementation for the compact thrift protocol.
		
		https://github.com/apache/thrift/blob/master/doc/specs/thrift-compact-protocol.md#integer-encoding

		Methods (total 3)
			(*CompactProtocol) Features() Features
			(*CompactProtocol) NewReader(r io.Reader) Reader
			(*CompactProtocol) NewWriter(w io.Writer) Writer
		Implements (at least one exported)
			*CompactProtocol : Protocol

	 type Decoder (struct)

		Methods (total 3)
			(*Decoder) Decode(v interface{}) error
			(*Decoder) Reset(r Reader)
			(*Decoder) SetStrict(enabled bool)
		Implements (at least one exported)
			*Decoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Decoder
		As Outputs Of (at least one exported)
			func NewDecoder(r Reader) *Decoder

	 type Encoder (struct)

		Methods (total 2)
			(*Encoder) Encode(v interface{}) error
			(*Encoder) Reset(w Writer)
		Implements (at least 2)
			*Encoder : github.com/grpc-ecosystem/grpc-gateway/v2/runtime.Encoder
			*Encoder : go.uber.org/zap/zapcore.ReflectedEncoder
		As Outputs Of (at least one exported)
			func NewEncoder(w Writer) *Encoder

	 type Features uint (basic type)
		Features is a bitset describing the thrift encoding features supported by
		protocol implementations.

		As Outputs Of (at least 3)
			func (*BinaryProtocol).Features() Features
			func (*CompactProtocol).Features() Features
			func Protocol.Features() Features
		As Types Of (total 2)
			const CoalesceBoolFields
			const UseDeltaEncoding

	 type Field (struct)

		Fields (total 3)
			Delta bool
				// whether the field id is a delta

			ID int16
			Type Type
		Methods (only one)
			( Field) String() string
		Implements (at least 2)
			 Field : expvar.Var
			 Field : fmt.Stringer
		As Outputs Of (at least one exported)
			func Reader.ReadField() (Field, error)
		As Inputs Of (at least one exported)
			func Writer.WriteField(Field) error

	 type List (struct)

		Fields (total 2)
			Size int32
			Type Type
		Methods (only one)
			( List) String() string
		Implements (at least 2)
			 List : expvar.Var
			 List : fmt.Stringer
		As Outputs Of (at least one exported)
			func Reader.ReadList() (List, error)
		As Inputs Of (at least one exported)
			func Writer.WriteList(List) error

	 type Map (struct)

		Fields (total 3)
			Key Type
			Size int32
			Value Type
		Methods (only one)
			( Map) String() string
		Implements (at least 2)
			 Map : expvar.Var
			 Map : fmt.Stringer
		As Outputs Of (at least one exported)
			func Reader.ReadMap() (Map, error)
		As Inputs Of (at least one exported)
			func Writer.WriteMap(Map) error

	 type Message (struct)

		Fields (total 3)
			Name string
			SeqID int32
			Type MessageType
		As Outputs Of (at least one exported)
			func Reader.ReadMessage() (Message, error)
		As Inputs Of (at least one exported)
			func Writer.WriteMessage(Message) error

	 type MessageType int8 (basic type)

		Methods (only one)
			( MessageType) String() string
		Implements (at least 2)
			 MessageType : expvar.Var
			 MessageType : fmt.Stringer
		As Types Of (total 4)
			const Call
			const Exception
			const Oneway
			const Reply

	 type MissingField (struct)

		Fields (only one)
			Field Field
		Methods (only one)
			(*MissingField) Error() string
		Implements (at least one exported)
			*MissingField : error

	 type Protocol (interface)
		The Protocol interface abstracts the creation of low-level thrift readers and
		writers implementing the various protocols that the encoding supports.
		
		Protocol instances must be safe to use concurrently from multiple gourintes.
		However, the readers and writer that they instantiates are intended to be
		used by a single goroutine.

		Methods (total 3)
			( Protocol) Features() Features
			( Protocol) NewReader(r io.Reader) Reader
			( Protocol) NewWriter(w io.Writer) Writer
		Implemented By (at least 2)
			*BinaryProtocol
			*CompactProtocol
		As Outputs Of (at least 2)
			func Reader.Protocol() Protocol
			func Writer.Protocol() Protocol
		As Inputs Of (at least 2)
			func Marshal(p Protocol, v interface{}) ([]byte, error)
			func Unmarshal(p Protocol, b []byte, v interface{}) error

	 type Reader (interface)
		Reader represents a low-level reader of values encoded according to one of
		the thrift protocols.

		Methods (total 16)
			( Reader) Protocol() Protocol
			( Reader) ReadBool() (bool, error)
			( Reader) ReadBytes() ([]byte, error)
			( Reader) ReadField() (Field, error)
			( Reader) ReadFloat64() (float64, error)
			( Reader) ReadInt16() (int16, error)
			( Reader) ReadInt32() (int32, error)
			( Reader) ReadInt64() (int64, error)
			( Reader) ReadInt8() (int8, error)
			( Reader) ReadLength() (int, error)
			( Reader) ReadList() (List, error)
			( Reader) ReadMap() (Map, error)
			( Reader) ReadMessage() (Message, error)
			( Reader) ReadSet() (Set, error)
			( Reader) ReadString() (string, error)
			( Reader) Reader() io.Reader
		As Outputs Of (at least 4)
			func NewDebugReader(r Reader, l *log.Logger) Reader
			func (*BinaryProtocol).NewReader(r io.Reader) Reader
			func (*CompactProtocol).NewReader(r io.Reader) Reader
			func Protocol.NewReader(r io.Reader) Reader
		As Inputs Of (at least 3)
			func NewDebugReader(r Reader, l *log.Logger) Reader
			func NewDecoder(r Reader) *Decoder
			func (*Decoder).Reset(r Reader)

	 type Set List (struct)

		Fields (total 2)
			Size int32
			Type Type
		Methods (only one)
			( Set) String() string
		Implements (at least 2)
			 Set : expvar.Var
			 Set : fmt.Stringer
		As Outputs Of (at least one exported)
			func Reader.ReadSet() (Set, error)
		As Inputs Of (at least one exported)
			func Writer.WriteSet(Set) error

	 type Type int8 (basic type)

		Methods (total 2)
			( Type) GoString() string
			( Type) String() string
		Implements (at least 3)
			 Type : expvar.Var
			 Type : fmt.GoStringer
			 Type : fmt.Stringer
		As Outputs Of (at least one exported)
			func TypeOf(t reflect.Type) Type
		As Types Of (total 14)
			const BINARY
			const BOOL
			const DOUBLE
			const FALSE
			const I16
			const I32
			const I64
			const I8
			const LIST
			const MAP
			const SET
			const STOP
			const STRUCT
			const TRUE

	 type TypeMismatch (struct)

		Fields (total 2)
			Expect Type
			Found Type
		Methods (only one)
			(*TypeMismatch) Error() string
		Implements (at least one exported)
			*TypeMismatch : error

	 type Writer (interface)
		Writer represents a low-level writer of values encoded according to one of
		the thrift protocols.

		Methods (total 16)
			( Writer) Protocol() Protocol
			( Writer) WriteBool(bool) error
			( Writer) WriteBytes([]byte) error
			( Writer) WriteField(Field) error
			( Writer) WriteFloat64(float64) error
			( Writer) WriteInt16(int16) error
			( Writer) WriteInt32(int32) error
			( Writer) WriteInt64(int64) error
			( Writer) WriteInt8(int8) error
			( Writer) WriteLength(int) error
			( Writer) WriteList(List) error
			( Writer) WriteMap(Map) error
			( Writer) WriteMessage(Message) error
			( Writer) WriteSet(Set) error
			( Writer) WriteString(string) error
			( Writer) Writer() io.Writer
		As Outputs Of (at least 4)
			func NewDebugWriter(w Writer, l *log.Logger) Writer
			func (*BinaryProtocol).NewWriter(w io.Writer) Writer
			func (*CompactProtocol).NewWriter(w io.Writer) Writer
			func Protocol.NewWriter(w io.Writer) Writer
		As Inputs Of (at least 3)
			func NewDebugWriter(w Writer, l *log.Logger) Writer
			func NewEncoder(w Writer) *Encoder
			func (*Encoder).Reset(w Writer)


Package-Level Functions (total 7)

	 func Marshal(p Protocol, v interface{}) ([]byte, error)
		Marshal serializes v into a thrift representation according to the the
		protocol p.
		
		The function panics if v cannot be converted to a thrift representation.

	 func NewDebugReader(r Reader, l *log.Logger) Reader
	 func NewDebugWriter(w Writer, l *log.Logger) Writer
	 func NewDecoder(r Reader) *Decoder
	 func NewEncoder(w Writer) *Encoder
	 func TypeOf(t reflect.Type) Type
	 func Unmarshal(p Protocol, b []byte, v interface{}) error
		Unmarshal deserializes the thrift data from b to v using to the protocol p.
		
		The function errors if the data in b does not match the type of v.
		
		The function panics if v cannot be converted to a thrift representation.
		
		As an optimization, the value passed in v may be reused across multiple calls
		to Unmarshal, allowing the function to reuse objects referenced by pointer
		fields of struct values. When reusing objects, the application is responsible
		for resetting the state of v before calling Unmarshal again.


Package-Level Constants (total 20)

	const BINARY Type = 8
	const BOOL Type = 2
	const Call MessageType = 0
	const CoalesceBoolFields Features = 2
		CoalesceBoolFields is advertised by protocols that allow encoders to
		coalesce boolean values into field types.

	const DOUBLE Type = 7
	const Exception MessageType = 2
	const FALSE Type = 2
	const I16 Type = 4
	const I32 Type = 5
	const I64 Type = 6
	const I8 Type = 3
	const LIST Type = 9
	const MAP Type = 11
	const Oneway MessageType = 3
	const Reply MessageType = 1
	const SET Type = 10
	const STOP Type = 0
	const STRUCT Type = 12
	const TRUE Type = 1
	const UseDeltaEncoding Features = 1
		DeltaEncoding is advertised by protocols that allow encoders to apply
		delta encoding on struct fields.

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.