package pgproto3

Import Path
	github.com/jackc/pgproto3/v2 (on go.dev)

Dependency Relation
	imports 10 packages, and imported by 2 packages

Involved Source Files

	      authentication_cleartext_password.go
	      authentication_md5_password.go
	      authentication_ok.go
	      authentication_sasl.go
	      authentication_sasl_continue.go
	      authentication_sasl_final.go
	      backend.go
	      backend_key_data.go
	      big_endian.go
	      bind.go
	      bind_complete.go
	      cancel_request.go
	      chunkreader.go
	      close.go
	      close_complete.go
	      command_complete.go
	      copy_both_response.go
	      copy_data.go
	      copy_done.go
	      copy_fail.go
	      copy_in_response.go
	      copy_out_response.go
	      data_row.go
	      describe.go
	   d➜ doc.go
		Package pgproto3 is a encoder and decoder of the PostgreSQL wire protocol version 3.

		See https://www.postgresql.org/docs/current/protocol-message-formats.html for meanings of the different messages.

	      empty_query_response.go
	      error_response.go
	      execute.go
	      flush.go
	      frontend.go
	      function_call_response.go
	      gss_enc_request.go
	      no_data.go
	      notice_response.go
	      notification_response.go
	      parameter_description.go
	      parameter_status.go
	      parse.go
	      parse_complete.go
	      password_message.go
	      pgproto3.go
	      portal_suspended.go
	      query.go
	      ready_for_query.go
	      row_description.go
	      sasl_initial_response.go
	      sasl_response.go
	      ssl_request.go
	      startup_message.go
	      sync.go
	      terminate.go
Package-Level Type Names (total 55, in which 53 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AuthenticationCleartextPassword (struct)
		AuthenticationCleartextPassword is a message sent from the backend indicating that a clear-text password is required.

		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message

	 type AuthenticationMD5Password (struct)
		AuthenticationMD5Password is a message sent from the backend indicating that an MD5 hashed password is required.

		Fields (only one, which is exported)
			Salt [4]byte
		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message

	 type AuthenticationOk (struct)
		AuthenticationOk is a message sent from the backend indicating that authentication was successful.

		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message

	 type AuthenticationSASL (struct)
		AuthenticationSASL is a message sent from the backend indicating that SASL authentication is required.

		Fields (only one, which is exported)
			AuthMechanisms []string
		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message

	 type AuthenticationSASLContinue (struct)
		AuthenticationSASLContinue is a message sent from the backend containing a SASL challenge.

		Fields (only one, which is exported)
			Data []byte
		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jackc/pgconn.(*PgConn).rxSASLContinue() (*AuthenticationSASLContinue, error)

	 type AuthenticationSASLFinal (struct)
		AuthenticationSASLFinal is a message sent from the backend indicating a SASL authentication has completed.

		Fields (only one, which is exported)
			Data []byte
		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jackc/pgconn.(*PgConn).rxSASLFinal() (*AuthenticationSASLFinal, error)

	 type Backend (struct)
		Backend acts as a server for the PostgreSQL wire protocol version 3.

		Fields (total 20, none are exported)
			/* 20 unexporteds ... *//* 20 unexporteds: */
			_close Close
			bind Bind
				Frontend message flyweights

			bodyLen int
			cancelRequest CancelRequest
			copyFail CopyFail
			cr ChunkReader
			describe Describe
			execute Execute
			flush Flush
			gssEncRequest GSSEncRequest
			msgType byte
			parse Parse
			partialMsg bool
			passwordMessage PasswordMessage
			query Query
			sslRequest SSLRequest
			startupMessage StartupMessage
			sync Sync
			terminate Terminate
			w io.Writer
		Methods (total 3, all are exported)
			(*T) Receive() (FrontendMessage, error)
				Receive receives a message from the frontend. The returned message is only valid until the next call to Receive.

			(*T) ReceiveStartupMessage() (FrontendMessage, error)
				ReceiveStartupMessage receives the initial connection message. This method is used of the normal Receive method
				because the initial connection message is "special" and does not include the message type as the first byte. This
				will return either a StartupMessage, SSLRequest, GSSEncRequest, or CancelRequest.

			(*T) Send(msg BackendMessage) error
				Send sends a message to the frontend.

		As Outputs Of (at least one exported)
			func NewBackend(cr ChunkReader, w io.Writer) *Backend

	 type BackendKeyData (struct)

		Fields (total 2, both are exported)
			ProcessID uint32
			SecretKey uint32
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type BackendMessage (interface)

		Methods (total 3, all are exported)
			( T) Backend()
				// no-op method to distinguish frontend from backend methods

			( T) Decode(data []byte) error
				Decode is allowed and expected to retain a reference to data after
				returning (unlike encoding.BinaryUnmarshaler).

			( T) Encode(dst []byte) []byte
				Encode appends itself to dst and returns the new buffer.

		Implemented By (at least 28, all are exported)
			*AuthenticationCleartextPassword
			*AuthenticationMD5Password
			*AuthenticationOk
			*AuthenticationSASL
			*AuthenticationSASLContinue
			*AuthenticationSASLFinal
			*BackendKeyData
			*BindComplete
			*CloseComplete
			*CommandComplete
			*CopyBothResponse
			*CopyData
			*CopyDone
			*CopyInResponse
			*CopyOutResponse
			*DataRow
			*EmptyQueryResponse
			*ErrorResponse
			*FunctionCallResponse
			*NoData
			*NoticeResponse
			*NotificationResponse
			*ParameterDescription
			*ParameterStatus
			*ParseComplete
			*PortalSuspended
			*ReadyForQuery
			*RowDescription
		Implements (at least one exported)
			 T : Message
		As Outputs Of (at least 8, in which 3 are exported)
			func (*Frontend).Receive() (BackendMessage, error)
			func github.com/jackc/pgconn.Frontend.Receive() (BackendMessage, error)
			func github.com/jackc/pgconn.(*PgConn).ReceiveMessage(ctx context.Context) (BackendMessage, error)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			func (*Frontend).findAuthenticationMessageType(src []byte) (BackendMessage, error)
			func github.com/jackc/pgconn.(*MultiResultReader).receiveMessage() (BackendMessage, error)
			func github.com/jackc/pgconn.(*PgConn).peekMessage() (BackendMessage, error)
			func github.com/jackc/pgconn.(*PgConn).receiveMessage() (BackendMessage, error)
			func github.com/jackc/pgconn.(*ResultReader).receiveMessage() (msg BackendMessage, err error)
		As Inputs Of (at least one exported)
			func (*Backend).Send(msg BackendMessage) error

	 type BigEndianBuf ([...]T)

		Methods (total 5, all are exported)
			( T) Int16(n int16) []byte
			( T) Int32(n int32) []byte
			( T) Int64(n int64) []byte
			( T) Uint16(n uint16) []byte
			( T) Uint32(n uint32) []byte

	 type Bind (struct)

		Fields (total 5, all are exported)
			DestinationPortal string
			ParameterFormatCodes []int16
			Parameters [][]byte
			PreparedStatement string
			ResultFormatCodes []int16
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type BindComplete (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CancelRequest (struct)

		Fields (total 2, both are exported)
			ProcessID uint32
			SecretKey uint32
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ChunkReader (interface)
		ChunkReader is an interface to decouple github.com/jackc/chunkreader from this package.

		Methods (only one, which is exported)
			( T) Next(n int) (buf []byte, err error)
				Next returns buf filled with the next n bytes. If an error (including a partial read) occurs,
				buf must be nil. Next must preserve any partially read data. Next must not reuse buf.

		Implemented By (at least one exported)
			*github.com/jackc/chunkreader/v2.ChunkReader
		As Outputs Of (at least one exported)
			func NewChunkReader(r io.Reader) ChunkReader
		As Inputs Of (at least 2, both are exported)
			func NewBackend(cr ChunkReader, w io.Writer) *Backend
			func NewFrontend(cr ChunkReader, w io.Writer) *Frontend

	 type Close (struct)

		Fields (total 2, both are exported)
			Name string
			ObjectType byte
				// 'S' = prepared statement, 'P' = portal

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CloseComplete (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CommandComplete (struct)

		Fields (only one, which is exported)
			CommandTag []byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyBothResponse (struct)

		Fields (total 2, both are exported)
			ColumnFormatCodes []uint16
			OverallFormat byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyData (struct)

		Fields (only one, which is exported)
			Data []byte
		Methods (total 5, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 4, all are exported)
			*T : BackendMessage
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyDone (struct)

		Methods (total 5, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 4, all are exported)
			*T : BackendMessage
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyFail (struct)

		Fields (only one, which is exported)
			Message string
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyInResponse (struct)

		Fields (total 2, both are exported)
			ColumnFormatCodes []uint16
			OverallFormat byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type CopyOutResponse (struct)

		Fields (total 2, both are exported)
			ColumnFormatCodes []uint16
			OverallFormat byte
		Methods (total 4, all are exported)
			(*T) Backend()
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type DataRow (struct)

		Fields (only one, which is exported)
			Values [][]byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Describe (struct)

		Fields (total 2, both are exported)
			Name string
			ObjectType byte
				// 'S' = prepared statement, 'P' = portal

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type EmptyQueryResponse (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ErrorResponse (struct)

		Fields (total 18, all are exported)
			Code string
			ColumnName string
			ConstraintName string
			DataTypeName string
			Detail string
			File string
			Hint string
			InternalPosition int32
			InternalQuery string
			Line int32
			Message string
			Position int32
			Routine string
			SchemaName string
			Severity string
			TableName string
			UnknownFields map[byte]string
			Where string
		Methods (total 4, in which 3 are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			/* one unexported ... *//* one unexported: */
			(*T) marshalBinary(typeByte byte) []byte
		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message
		As Inputs Of (at least one exported)
			func github.com/jackc/pgconn.ErrorResponseToPgError(msg *ErrorResponse) *pgconn.PgError

	 type Execute (struct)

		Fields (total 2, both are exported)
			MaxRows uint32
			Portal string
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type FieldDescription (struct)

		Fields (total 7, all are exported)
			DataTypeOID uint32
			DataTypeSize int16
			Format int16
			Name []byte
			TableAttributeNumber uint16
			TableOID uint32
			TypeModifier int32
		Methods (only one, which is exported)
			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least one exported)
			 T : encoding/json.Marshaler
		As Outputs Of (at least 3, all are exported)
			func github.com/jackc/pgconn.(*ResultReader).FieldDescriptions() []FieldDescription
			func github.com/jackc/pgx/v4.QueryFuncRow.FieldDescriptions() []FieldDescription
			func github.com/jackc/pgx/v4.Rows.FieldDescriptions() []FieldDescription
		As Inputs Of (at least one exported)
			func github.com/jackc/pgx/v4.ScanRow(connInfo *pgtype.ConnInfo, fieldDescriptions []FieldDescription, values [][]byte, dest ...interface{}) error

	 type Flush (struct)

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Frontend (struct)
		Frontend acts as a client for the PostgreSQL wire protocol version 3.

		Fields (total 33, none are exported)
			/* 33 unexporteds ... *//* 33 unexporteds: */
			authenticationCleartextPassword AuthenticationCleartextPassword
			authenticationMD5Password AuthenticationMD5Password
			authenticationOk AuthenticationOk
				Backend message flyweights

			authenticationSASL AuthenticationSASL
			authenticationSASLContinue AuthenticationSASLContinue
			authenticationSASLFinal AuthenticationSASLFinal
			backendKeyData BackendKeyData
			bindComplete BindComplete
			bodyLen int
			closeComplete CloseComplete
			commandComplete CommandComplete
			copyBothResponse CopyBothResponse
			copyData CopyData
			copyDone CopyDone
			copyInResponse CopyInResponse
			copyOutResponse CopyOutResponse
			cr ChunkReader
			dataRow DataRow
			emptyQueryResponse EmptyQueryResponse
			errorResponse ErrorResponse
			functionCallResponse FunctionCallResponse
			msgType byte
			noData NoData
			noticeResponse NoticeResponse
			notificationResponse NotificationResponse
			parameterDescription ParameterDescription
			parameterStatus ParameterStatus
			parseComplete ParseComplete
			partialMsg bool
			portalSuspended PortalSuspended
			readyForQuery ReadyForQuery
			rowDescription RowDescription
			w io.Writer
		Methods (total 3, in which 2 are exported)
			(*T) Receive() (BackendMessage, error)
				Receive receives a message from the backend. The returned message is only valid until the next call to Receive.

			(*T) Send(msg FrontendMessage) error
				Send sends a message to the backend.

			/* one unexported ... *//* one unexported: */
			(*T) findAuthenticationMessageType(src []byte) (BackendMessage, error)
		Implements (at least one exported)
			*T : github.com/jackc/pgconn.Frontend
		As Outputs Of (at least one exported)
			func NewFrontend(cr ChunkReader, w io.Writer) *Frontend

	 type FrontendMessage (interface)

		Methods (total 3, all are exported)
			( T) Decode(data []byte) error
				Decode is allowed and expected to retain a reference to data after
				returning (unlike encoding.BinaryUnmarshaler).

			( T) Encode(dst []byte) []byte
				Encode appends itself to dst and returns the new buffer.

			( T) Frontend()
				// no-op method to distinguish frontend from backend methods

		Implemented By (at least 19, all are exported)
			*Bind
			*CancelRequest
			*Close
			*CopyData
			*CopyDone
			*CopyFail
			*Describe
			*Execute
			*Flush
			*GSSEncRequest
			*Parse
			*PasswordMessage
			*Query
			*SASLInitialResponse
			*SASLResponse
			*SSLRequest
			*StartupMessage
			*Sync
			*Terminate
		Implements (at least one exported)
			 T : Message
		As Outputs Of (at least 2, both are exported)
			func (*Backend).Receive() (FrontendMessage, error)
			func (*Backend).ReceiveStartupMessage() (FrontendMessage, error)
		As Inputs Of (at least one exported)
			func (*Frontend).Send(msg FrontendMessage) error

	 type FunctionCallResponse (struct)

		Fields (only one, which is exported)
			Result []byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type GSSEncRequest (struct)

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Message (interface)
		Message is the interface implemented by an object that can decode and encode
		a particular PostgreSQL message.

		Methods (total 2, both are exported)
			( T) Decode(data []byte) error
				Decode is allowed and expected to retain a reference to data after
				returning (unlike encoding.BinaryUnmarshaler).

			( T) Encode(dst []byte) []byte
				Encode appends itself to dst and returns the new buffer.

		Implemented By (at least 47, all are exported)
			*AuthenticationCleartextPassword
			*AuthenticationMD5Password
			*AuthenticationOk
			*AuthenticationSASL
			*AuthenticationSASLContinue
			*AuthenticationSASLFinal
			*BackendKeyData
			 BackendMessage (interface)
			*Bind
			*BindComplete
			*CancelRequest
			*Close
			*CloseComplete
			*CommandComplete
			*CopyBothResponse
			*CopyData
			*CopyDone
			*CopyFail
			*CopyInResponse
			*CopyOutResponse
			*DataRow
			*Describe
			*EmptyQueryResponse
			*ErrorResponse
			*Execute
			*Flush
			 FrontendMessage (interface)
			*FunctionCallResponse
			*GSSEncRequest
			*NoData
			*NoticeResponse
			*NotificationResponse
			*ParameterDescription
			*ParameterStatus
			*Parse
			*ParseComplete
			*PasswordMessage
			*PortalSuspended
			*Query
			*ReadyForQuery
			*RowDescription
			*SASLInitialResponse
			*SASLResponse
			*SSLRequest
			*StartupMessage
			*Sync
			*Terminate

	 type NoData (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type NoticeResponse ErrorResponse (struct)

		Fields (total 18, all are exported)
			Code string
			ColumnName string
			ConstraintName string
			DataTypeName string
			Detail string
			File string
			Hint string
			InternalPosition int32
			InternalQuery string
			Line int32
			Message string
			Position int32
			Routine string
			SchemaName string
			Severity string
			TableName string
			UnknownFields map[byte]string
			Where string
		Methods (total 3, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

		Implements (at least 2, both are exported)
			*T : BackendMessage
			*T : Message
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func github.com/jackc/pgconn.noticeResponseToNotice(msg *NoticeResponse) *pgconn.Notice

	 type NotificationResponse (struct)

		Fields (total 3, all are exported)
			Channel string
			PID uint32
			Payload string
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ParameterDescription (struct)

		Fields (only one, which is exported)
			ParameterOIDs []uint32
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ParameterStatus (struct)

		Fields (total 2, both are exported)
			Name string
			Value string
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Parse (struct)

		Fields (total 3, all are exported)
			Name string
			ParameterOIDs []uint32
			Query string
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ParseComplete (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type PasswordMessage (struct)

		Fields (only one, which is exported)
			Password string
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type PortalSuspended (struct)

		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Query (struct)

		Fields (only one, which is exported)
			String string
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type ReadyForQuery (struct)

		Fields (only one, which is exported)
			TxStatus byte
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type RowDescription (struct)

		Fields (only one, which is exported)
			Fields []FieldDescription
		Methods (total 4, all are exported)
			(*T) Backend()
				Backend identifies this message as sendable by the PostgreSQL backend.

			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : BackendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type SASLInitialResponse (struct)

		Fields (total 2, both are exported)
			AuthMechanism string
			Data []byte
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type SASLResponse (struct)

		Fields (only one, which is exported)
			Data []byte
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type SSLRequest (struct)

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type StartupMessage (struct)

		Fields (total 2, both are exported)
			Parameters map[string]string
			ProtocolVersion uint32
		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Sync (struct)

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	 type Terminate (struct)

		Methods (total 4, all are exported)
			(*T) Decode(src []byte) error
				Decode decodes src into dst. src must contain the complete message with the exception of the initial 1 byte message
				type identifier and 4 byte message length.

			(*T) Encode(dst []byte) []byte
				Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

			(*T) Frontend()
				Frontend identifies this message as sendable by a PostgreSQL frontend.

			( T) MarshalJSON() ([]byte, error)
				MarshalJSON implements encoding/json.Marshaler.

		Implements (at least 3, all are exported)
			*T : FrontendMessage
			*T : Message
			 T : encoding/json.Marshaler

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type invalidMessageFormatErr (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			messageType string
		Methods (only one, which is exported)
			(*T) Error() string
		Implements (at least one exported)
			*T : error

	 type invalidMessageLenErr (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			actualLen int
			expectedLen int
			messageType string
		Methods (only one, which is exported)
			(*T) Error() string
		Implements (at least one exported)
			*T : error


Package-Level Functions (total 4, in which 3 are exported)

	 func NewBackend(cr ChunkReader, w io.Writer) *Backend
		NewBackend creates a new Backend.

	 func NewChunkReader(r io.Reader) ChunkReader
		NewChunkReader creates and returns a new default ChunkReader.

	 func NewFrontend(cr ChunkReader, w io.Writer) *Frontend
		NewFrontend creates a new Frontend.

	/* one unexported ... *//* one unexported: */
	 func translateEOFtoErrUnexpectedEOF(err error) error
Package-Level Constants (total 12, in which 9 are exported)

	const AuthTypeCleartextPassword = 3
		Authentication message type constants.

	const AuthTypeMD5Password = 5
		Authentication message type constants.

	const AuthTypeOk = 0
		Authentication message type constants.

	const AuthTypeSASL = 10
		Authentication message type constants.

	const AuthTypeSASLContinue = 11
		Authentication message type constants.

	const AuthTypeSASLFinal = 12
		Authentication message type constants.

	const BinaryFormat = 1
	const ProtocolVersionNumber = 196608 // 3.0
	const TextFormat = 0
	/* 3 unexporteds ... *//* 3 unexporteds: */
	const cancelRequestCode = 80877102
	const gssEncReqNumber = 80877104
	const sslRequestNumber = 80877103

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.