pgproto3

https://pkg.go.dev/github.com/jackc/pgproto3/v2
Admin
pgproto3 is a Go package that encodes and decodes the PostgreSQL wire protocol version 3, used as a...
Tokens:16,113
Snippets:167
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install pgfortune

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2/example/pgfortune

Install the pgfortune mock PostgreSQL server using go get. Ensure fortune and cowsay are installed on your system.

```bash
go get -u github.com/jackc/pgproto3/example/pgfortune

```

--------------------------------

### Example psql query and pgfortune response

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2/example/pgfortune

An example of a query sent to pgfortune via psql and the mock server's fortune-based response.

```sql
jack@127.0.0.1:15432 jack=# select foo;
                   fortune
─────────────────────────────────────────────
  _________________________________________
 / Ships are safe in harbor, but they were \
 \ never meant to stay there.              /
  -----------------------------------------
  \     /\  ___  /\                         \
   \   // \/   \/ \\                        \
      ((    O O    ))
       \\ /     \ //
        \/  | |  \/
         |  | |  |
         |  | |  |
         |   o   |
         | |   | |
         |m|   |m|

(1 row)

Time: 28.161 ms

```

--------------------------------

### Run pgfortune

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2/example/pgfortune

Execute the pgfortune command to start the mock PostgreSQL server. By default, it listens on 127.0.0.1:15432.

```bash
$ pgfortune

```

--------------------------------

### StartupMessage Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the startup message structure used to initiate a connection and its associated methods.

```go
type StartupMessage struct {
	ProtocolVersion uint32
	Parameters      map[string]string
}
```

```go
func (dst *StartupMessage) Decode(src []byte) error
```

```go
func (src *StartupMessage) Encode(dst []byte) ([]byte, error)
```

```go
func (*StartupMessage) Frontend()
```

```go
func (src StartupMessage) MarshalJSON() ([]byte, error)
```

--------------------------------

### Backend Operations

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for initializing a backend, receiving messages, and sending responses.

```go
func NewBackend(cr ChunkReader, w io.Writer) *Backend
```

```go
func (b *Backend) Receive() (FrontendMessage, error)
```

```go
func (b *Backend) ReceiveStartupMessage() (FrontendMessage, error)
```

```go
func (b *Backend) Send(msg BackendMessage) error
```

```go
func (b *Backend) SetAuthType(authType uint32) error
```

--------------------------------

### Connect to pgfortune with psql

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2/example/pgfortune

Connect to the running pgfortune server using the psql client. This demonstrates how to interact with the mock server.

```bash
$ psql -h 127.0.0.1 -p 15432

```

--------------------------------

### StartupMessage

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents the initial startup message sent by a client to establish a connection, including protocol version and parameters.

```APIDOC
## StartupMessage

### Description
Represents the initial startup message sent by a client to establish a connection, including protocol version and parameters.

### Type Definition
```go
type StartupMessage struct {
	ProtocolVersion uint32
	Parameters      map[string]string
}
```

### Methods
#### Decode
```go
func (dst *StartupMessage) Decode(src []byte) error
```
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.

#### Encode
```go
func (src *StartupMessage) Encode(dst []byte) ([]byte, error)
```
Encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### Frontend
```go
func (*StartupMessage) Frontend()
```
Frontend identifies this message as sendable by a PostgreSQL frontend.

#### MarshalJSON
```go
func (src StartupMessage) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.
```

--------------------------------

### NewFrontend Constructor in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Creates a new Frontend client for PostgreSQL wire protocol communication.

```go
func NewFrontend(cr ChunkReader, w io.Writer) *Frontend
```

--------------------------------

### List of Source Files

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

A list of all Go source files within the pgproto3 package.

```APIDOC
## Source Files

### Description
This section lists all the Go source files that constitute the pgproto3 package.

### Files
- authentication_cleartext_password.go
- authentication_gss.go
- authentication_gss_continue.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
- doc.go
- empty_query_response.go
- error_response.go
- execute.go
- flush.go
- frontend.go
- function_call.go
- function_call_response.go
- gss_enc_request.go
- gss_response.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
```

--------------------------------

### ReadyForQuery API

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles backend messages indicating the server is ready for a new query.

```APIDOC
## ReadyForQuery

### Description
Represents a ReadyForQuery message sent by the PostgreSQL backend.

### Methods
- **Decode(src []byte) error**: Decodes binary data into the struct.
- **Encode(dst []byte) ([]byte, error)**: Encodes the struct into binary format.
- **MarshalJSON() ([]byte, error)**: Implements encoding/json.Marshaler.
- **UnmarshalJSON(data []byte) error**: Implements encoding/json.Unmarshaler.
- **Backend()**: Identifies as a backend message.
```

--------------------------------

### Describe MarshalJSON Implementation

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for Describe.

```go
func (src Describe) MarshalJSON() ([]byte, error)

```

--------------------------------

### Backend

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Acts as a server for the PostgreSQL wire protocol version 3.

```APIDOC
## Backend

### Description
Backend acts as a server for the PostgreSQL wire protocol version 3.

### Methods
- **NewBackend**(cr ChunkReader, w io.Writer) *Backend: Creates a new Backend.
- **Receive**() (FrontendMessage, error): Receives a message from the frontend. The returned message is only valid until the next call to Receive.
- **ReceiveStartupMessage**() (FrontendMessage, error): 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.
- **Send**(msg BackendMessage) error: Sends a message to the frontend.
- **SetAuthType**(authType uint32) error: Sets the authentication type in the backend. Since multiple message types can start with 'p', SetAuthType allows contextual identification of FrontendMessages. For example, in the PG message flow documentation for PasswordMessage: Byte1('p') Identifies the message as a password response. Note that this is also used for GSSAPI, SSPI and SASL response messages. The exact message type can be deduced from the context. Since the Frontend does not know about the state of a backend, it is important to call SetAuthType() after an authentication request is received by the Frontend.

```

--------------------------------

### AuthenticationOk Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Definition and interface implementations for the successful authentication message.

```go
type AuthenticationOk struct {
}
```

```go
func (*AuthenticationOk) AuthenticationResponse()
```

```go
func (*AuthenticationOk) Backend()
```

```go
func (dst *AuthenticationOk) Decode(src []byte) error
```

```go
func (src *AuthenticationOk) Encode(dst []byte) ([]byte, error)
```

```go
func (src AuthenticationOk) MarshalJSON() ([]byte, error)
```

--------------------------------

### BackendKeyData Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for identifying, decoding, encoding, and JSON marshaling of BackendKeyData.

```go
func (*BackendKeyData) Backend()
```

```go
func (dst *BackendKeyData) Decode(src []byte) error
```

```go
func (src *BackendKeyData) Encode(dst []byte) ([]byte, error)
```

```go
func (src BackendKeyData) MarshalJSON() ([]byte, error)
```

--------------------------------

### Define Backend

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents the server-side handler for the PostgreSQL wire protocol version 3.

```go
type Backend struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### Describe UnmarshalJSON Implementation (v2.1.0+)

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Unmarshaler interface for Describe. Added in v2.1.0.

```go
func (dst *Describe) UnmarshalJSON(data []byte) error

```

--------------------------------

### AuthenticationSASLFinal Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for identifying, decoding, encoding, and JSON marshaling of AuthenticationSASLFinal messages.

```go
func (*AuthenticationSASLFinal) AuthenticationResponse()
```

```go
func (*AuthenticationSASLFinal) Backend()
```

```go
func (dst *AuthenticationSASLFinal) Decode(src []byte) error
```

```go
func (src *AuthenticationSASLFinal) Encode(dst []byte) ([]byte, error)
```

```go
func (src AuthenticationSASLFinal) MarshalJSON() ([]byte, error)
```

```go
func (dst *AuthenticationSASLFinal) UnmarshalJSON(data []byte) error
```

--------------------------------

### AuthenticationMD5Password Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for decoding, encoding, and JSON marshaling of MD5 authentication messages.

```go
func (dst *AuthenticationMD5Password) Decode(src []byte) error
```

```go
func (src *AuthenticationMD5Password) Encode(dst []byte) ([]byte, error)
```

```go
func (src AuthenticationMD5Password) MarshalJSON() ([]byte, error)
```

```go
func (dst *AuthenticationMD5Password) UnmarshalJSON(data []byte) error
```

--------------------------------

### ChunkReader Interface and Constructor

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Interface for reading chunks of data and a constructor for the default implementation.

```go
type ChunkReader interface {
	// 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.
	Next(n int) (buf []byte, err error)
}
```

```go
func NewChunkReader(r io.Reader) ChunkReader
```

--------------------------------

### Receive BackendMessage in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Receives a message from the PostgreSQL backend. The returned message is valid until the next call.

```go
func (f *Frontend) Receive() (BackendMessage, error)
```

--------------------------------

### Send FrontendMessage in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Sends a message to the PostgreSQL backend.

```go
func (f *Frontend) Send(msg FrontendMessage) error
```

--------------------------------

### Frontend Client API

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for interacting with the PostgreSQL backend using the Frontend client.

```APIDOC
## Frontend Client

### Description
The Frontend struct acts as a client for the PostgreSQL wire protocol version 3.

### Methods
- **NewFrontend(cr ChunkReader, w io.Writer) *Frontend** - Creates a new Frontend instance.
- **GetAuthType() uint32** - Returns the current authType.
- **Receive() (BackendMessage, error)** - Receives a message from the backend.
- **Send(msg FrontendMessage) error** - Sends a message to the backend.
```

--------------------------------

### Sync Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the Sync message used for protocol synchronization and its associated methods.

```go
type Sync struct{}
```

```go
func (dst *Sync) Decode(src []byte) error
```

```go
func (src *Sync) Encode(dst []byte) ([]byte, error)
```

```go
func (*Sync) Frontend()
```

```go
func (src Sync) MarshalJSON() ([]byte, error)
```

--------------------------------

### MarshalJSON for Execute in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for Execute.

```go
func (src Execute) MarshalJSON() ([]byte, error)
```

--------------------------------

### Describe Decode Method

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Decodes a byte slice into a Describe message. The input must be the complete message excluding the initial message type identifier and length.

```go
func (dst *Describe) Decode(src []byte) error

```

--------------------------------

### Frontend Message Handling

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

The Frontend struct provides methods to interact with the PostgreSQL backend by sending and receiving protocol messages.

```APIDOC
## Frontend Message Exchange

### Description
Provides the interface for a client to communicate with a PostgreSQL backend using the pgproto3 protocol.

### Methods
- **NewFrontend(cr ChunkReader, w io.Writer) *Frontend** - Initializes a new Frontend instance.
- **Send(msg FrontendMessage) error** - Sends a message to the backend.
- **Receive() (BackendMessage, error)** - Receives a message from the backend.
- **GetAuthType() uint32** - Retrieves the authentication type.
```

--------------------------------

### BackendKeyData

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Contains process ID and secret key for backend identification.

```APIDOC
## BackendKeyData

### Description
BackendKeyData contains the process ID and secret key for backend identification.

### Fields
- **ProcessID** (uint32)
- **SecretKey** (uint32)

### Methods
- **Backend**(): Backend identifies this message as sendable by the PostgreSQL backend.
- **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.
- **Encode**(dst []byte) ([]byte, error): Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.
- **MarshalJSON**() ([]byte, error): MarshalJSON implements encoding/json.Marshaler.

```

--------------------------------

### AuthenticationOk

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents a successful authentication response.

```APIDOC
## AuthenticationOk

### Description
AuthenticationOk is a message sent from the backend indicating that authentication was successful.

### Methods

#### AuthenticationResponse
```go
func (*AuthenticationOk) AuthenticationResponse()
```
Backend identifies this message as an authentication response.

#### Backend
```go
func (*AuthenticationOk) Backend()
```
Backend identifies this message as sendable by the PostgreSQL backend.

#### Decode
```go
func (dst *AuthenticationOk) 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.

#### Encode
```go
func (src *AuthenticationOk) Encode(dst []byte) ([]byte, error)
```
Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### MarshalJSON
```go
func (src AuthenticationOk) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.
```

--------------------------------

### Describe Encode Method

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Encodes a Describe message into a byte slice, including the message type identifier and length.

```go
func (src *Describe) Encode(dst []byte) ([]byte, error)

```

--------------------------------

### BigEndianBuf Utilities

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Buffer type and methods for big-endian integer serialization.

```go
type BigEndianBuf [8]byte
```

```go
func (b BigEndianBuf) Int16(n int16) []byte
```

```go
func (b BigEndianBuf) Int32(n int32) []byte
```

```go
func (b BigEndianBuf) Int64(n int64) []byte
```

```go
func (b BigEndianBuf) Uint16(n uint16) []byte
```

--------------------------------

### Bind Message Operations

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Structures and methods for handling PostgreSQL Bind messages.

```go
type Bind struct {
	DestinationPortal    string
	PreparedStatement    string
	ParameterFormatCodes []int16
	Parameters           [][]byte
	ResultFormatCodes    []int16
}
```

```go
func (dst *Bind) Decode(src []byte) error
```

```go
func (src *Bind) Encode(dst []byte) ([]byte, error)
```

```go
func (*Bind) Frontend()
```

```go
func (src Bind) MarshalJSON() ([]byte, error)
```

```go
func (dst *Bind) UnmarshalJSON(data []byte) error
```

--------------------------------

### Describe Type Definition

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the Describe message structure, specifying the object type and name.

```go
type Describe struct {
	ObjectType byte // 'S' = prepared statement, 'P' = portal
	Name       string
}

```

--------------------------------

### MarshalJSON for FieldDescription in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for FieldDescription.

```go
func (fd FieldDescription) MarshalJSON() ([]byte, error)
```

--------------------------------

### MarshalJSON for Flush in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for Flush.

```go
func (src Flush) MarshalJSON() ([]byte, error)
```

--------------------------------

### FrontendMessage Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Interface for messages that can be sent by a PostgreSQL frontend.

```go
type FrontendMessage interface {
	Message
	Frontend() // no-op method to distinguish frontend from backend methods
}
```

--------------------------------

### Define BackendKeyData

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents the BackendKeyData message containing process and secret keys.

```go
type BackendKeyData struct {
	ProcessID uint32
	SecretKey uint32
}
```

--------------------------------

### Message Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

The base interface for all PostgreSQL protocol messages, requiring binary encoding and decoding capabilities.

```go
type Message interface {
	// Decode is allowed and expected to retain a reference to data after
	// returning (unlike encoding.BinaryUnmarshaler).
	Decode(data []byte) error

	// Encode appends itself to dst and returns the new buffer.
	Encode(dst []byte) ([]byte, error)
}
```

--------------------------------

### Frontend Identification for Execute in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies an Execute message as sendable by a PostgreSQL frontend.

```go
func (*Execute) Frontend()
```

--------------------------------

### Frontend Identification for Flush in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies a Flush message as sendable by a PostgreSQL frontend.

```go
func (*Flush) Frontend()
```

--------------------------------

### SASLInitialResponse Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the SASL initial response message and its associated encoding, decoding, and JSON marshaling methods.

```go
type SASLInitialResponse struct {
	AuthMechanism string
	Data          []byte
}
```

```go
func (dst *SASLInitialResponse) Decode(src []byte) error
```

```go
func (src *SASLInitialResponse) Encode(dst []byte) ([]byte, error)
```

```go
func (*SASLInitialResponse) Frontend()
```

```go
func (src SASLInitialResponse) MarshalJSON() ([]byte, error)
```

```go
func (dst *SASLInitialResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### Describe Frontend Identification

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies the Describe message as sendable by a PostgreSQL frontend.

```go
func (*Describe) Frontend()

```

--------------------------------

### DataRow MarshalJSON Implementation

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for DataRow.

```go
func (src DataRow) MarshalJSON() ([]byte, error)

```

--------------------------------

### AuthenticationSASL Message Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for handling SASL authentication requirement messages.

```go
type AuthenticationSASL struct {
	AuthMechanisms []string
}
```

```go
func (*AuthenticationSASL) AuthenticationResponse()
```

```go
func (*AuthenticationSASL) Backend()
```

```go
func (dst *AuthenticationSASL) Decode(src []byte) error
```

```go
func (src *AuthenticationSASL) Encode(dst []byte) ([]byte, error)
```

```go
func (src AuthenticationSASL) MarshalJSON() ([]byte, error)
```

--------------------------------

### PostgreSQL Data Format Constants

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Constants specifying the data format for PostgreSQL messages. Use TextFormat for text representation and BinaryFormat for binary representation.

```go
const (
	TextFormat   = 0
	BinaryFormat = 1
)
```

--------------------------------

### CopyFail MarshalJSON Implementation

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for CopyFail.

```go
func (src CopyFail) MarshalJSON() ([]byte, error)

```

--------------------------------

### BindComplete Message Operations

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Structures and methods for handling PostgreSQL BindComplete messages.

```go
type BindComplete struct{}
```

```go
func (*BindComplete) Backend()
```

```go
func (dst *BindComplete) Decode(src []byte) error
```

```go
func (src *BindComplete) Encode(dst []byte) ([]byte, error)
```

```go
func (src BindComplete) MarshalJSON() ([]byte, error)
```

--------------------------------

### SSLRequest Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the SSL request message and its associated encoding, decoding, and JSON marshaling methods.

```go
type SSLRequest struct {
}
```

```go
func (dst *SSLRequest) Decode(src []byte) error
```

```go
func (src *SSLRequest) Encode(dst []byte) ([]byte, error)
```

```go
func (*SSLRequest) Frontend()
```

```go
func (src SSLRequest) MarshalJSON() ([]byte, error)
```

--------------------------------

### Unmarshal AuthenticationSASLContinue

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements encoding/json.Unmarshaler for AuthenticationSASLContinue.

```go
func (dst *AuthenticationSASLContinue) UnmarshalJSON(data []byte) error
```

--------------------------------

### AuthenticationSASLContinue Message Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for handling SASL challenge messages from the backend.

```go
type AuthenticationSASLContinue struct {
	Data []byte
}
```

```go
func (*AuthenticationSASLContinue) AuthenticationResponse()
```

```go
func (*AuthenticationSASLContinue) Backend()
```

```go
func (dst *AuthenticationSASLContinue) Decode(src []byte) error
```

```go
func (src *AuthenticationSASLContinue) Encode(dst []byte) ([]byte, error)
```

```go
func (src AuthenticationSASLContinue) MarshalJSON() ([]byte, error)
```

--------------------------------

### Frontend Struct Definition in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents a client for the PostgreSQL wire protocol version 3. Contains filtered or unexported fields.

```go
type Frontend struct {
	// contains filtered or unexported fields
}
```

--------------------------------

### CopyInResponse MarshalJSON Implementation

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for CopyInResponse.

```go
func (src CopyInResponse) MarshalJSON() ([]byte, error)

```

--------------------------------

### Message Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

The base interface for all PostgreSQL protocol messages.

```APIDOC
## Message Interface

### Description
Interface implemented by objects that can decode and encode PostgreSQL messages.

### Methods
- **Decode(data []byte) error**: Decodes data into the message structure.
- **Encode(dst []byte) ([]byte, error)**: Appends the message to dst and returns the new buffer.
```

--------------------------------

### NoData Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the NoData message structure and its associated protocol methods.

```go
type NoData struct{}
```

```go
func (*NoData) Backend()
```

```go
func (*NoData) Decode(dst *NoData) error
```

```go
func (*NoData) Encode(src *NoData) ([]byte, error)
```

```go
func (NoData) MarshalJSON() ([]byte, error)
```

--------------------------------

### Define BackendMessage Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Interface for messages that can be sent by the PostgreSQL backend.

```go
type BackendMessage interface {
	Message
	Backend() // no-op method to distinguish frontend from backend methods
}
```

--------------------------------

### CopyOutResponse MarshalJSON Implementation

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for CopyOutResponse.

```go
func (src CopyOutResponse) MarshalJSON() ([]byte, error)

```

--------------------------------

### Describe Message

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles the Describe message used to request information about prepared statements or portals.

```APIDOC
## Describe

### Description
Requests information about a prepared statement or portal.

### Parameters
#### Request Body
- **ObjectType** (byte) - 'S' for prepared statement, 'P' for portal.
- **Name** (string) - The name of the object.

### Methods
- **Frontend()**: Identifies message as sendable by PostgreSQL frontend.
- **Decode(src []byte)**: Decodes raw bytes into the struct.
- **Encode(dst []byte)**: Encodes the struct into raw bytes.
- **MarshalJSON()**: Implements JSON marshaling.
- **UnmarshalJSON(data []byte)**: Implements JSON unmarshaling.
```

--------------------------------

### Backend Message Handling

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Methods for managing backend communication, including receiving messages and sending responses.

```APIDOC
## Backend Message Management

### Description
The Backend struct provides methods to interact with the PostgreSQL backend, allowing for message reception and transmission.

### Methods
- **NewBackend(cr ChunkReader, w io.Writer) *Backend** - Initializes a new Backend instance.
- **Receive() (FrontendMessage, error)** - Receives a message from the frontend.
- **ReceiveStartupMessage() (FrontendMessage, error)** - Receives the initial startup message.
- **Send(msg BackendMessage) error** - Sends a message to the backend.
- **SetAuthType(authType uint32) error** - Sets the authentication type for the session.
```

--------------------------------

### PostgreSQL Protocol Version Constant

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the constant for the PostgreSQL protocol version number, specifically version 3.0.

```go
const ProtocolVersionNumber = 196608 // 3.0
```

--------------------------------

### Terminate Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the Terminate message used to close a connection and its associated methods.

```go
type Terminate struct{}
```

```go
func (dst *Terminate) Decode(src []byte) error
```

```go
func (src *Terminate) Encode(dst []byte) ([]byte, error)
```

--------------------------------

### FunctionCall Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the FunctionCall message structure and its associated binary encoding, decoding, and frontend identification methods.

```go
type FunctionCall struct {
	Function         uint32
	ArgFormatCodes   []uint16
	Arguments        [][]byte
	ResultFormatCode uint16
}
```

```go
func (dst *FunctionCall) Decode(src []byte) error
```

```go
func (src *FunctionCall) Encode(dst []byte) ([]byte, error)
```

```go
func (*FunctionCall) Frontend()
```

--------------------------------

### MarshalJSON for EmptyQueryResponse in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for EmptyQueryResponse.

```go
func (src EmptyQueryResponse) MarshalJSON() ([]byte, error)
```

--------------------------------

### AuthenticationSASLContinue

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles the continuation of SASL authentication.

```APIDOC
## AuthenticationSASLContinue

### Description
Handles the continuation of SASL authentication.

### Methods
- **UnmarshalJSON**(data []byte) error: UnmarshalJSON implements encoding/json.Unmarshaler.

```

--------------------------------

### EmptyQueryResponse Type Definition

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the EmptyQueryResponse message, which has no fields.

```go
type EmptyQueryResponse struct{}

```

--------------------------------

### FunctionCallResponse Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the FunctionCallResponse message structure, including JSON marshaling and binary protocol handling.

```go
type FunctionCallResponse struct {
	Result []byte
}
```

```go
func (*FunctionCallResponse) Backend()
```

```go
func (*FunctionCallResponse) Decode(src []byte) error
```

```go
func (*FunctionCallResponse) Encode(src []byte) ([]byte, error)
```

```go
func (src FunctionCallResponse) MarshalJSON() ([]byte, error)
```

```go
func (*FunctionCallResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### Query API

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles simple query messages sent by the frontend.

```APIDOC
## Query

### Description
Represents a simple query message sent by the PostgreSQL frontend.

### Methods
- **Decode(src []byte) error**: Decodes binary data into the struct.
- **Encode(dst []byte) ([]byte, error)**: Encodes the struct into binary format.
- **MarshalJSON() ([]byte, error)**: Implements encoding/json.Marshaler.
- **Frontend()**: Identifies as a frontend message.
```

--------------------------------

### SSLRequest

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents a request for an SSL connection.

```APIDOC
## SSLRequest

### Description
Represents a request for an SSL connection.

### Type Definition
```go
type SSLRequest struct {
}
```

### Methods
#### Decode
```go
func (dst *SSLRequest) Decode(src []byte) error
```

#### Encode
```go
func (src *SSLRequest) Encode(dst []byte) ([]byte, error)
```
Encode encodes src into dst. dst will include the 4 byte message length.

#### Frontend
```go
func (*SSLRequest) Frontend()
```
Frontend identifies this message as sendable by a PostgreSQL frontend.

#### MarshalJSON
```go
func (src SSLRequest) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.
```

--------------------------------

### AuthenticationResponseMessage Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Interface definition for messages that represent an authentication response.

```go
type AuthenticationResponseMessage interface {
	BackendMessage
	AuthenticationResponse() // no-op method to distinguish authentication responses
}
```

--------------------------------

### AuthenticationSASLContinue

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles continuation messages for SASL authentication.

```APIDOC
## AuthenticationSASLContinue

### Description
AuthenticationSASLContinue is a message sent from the backend containing a SASL challenge, used to continue the SASL authentication process.

### Methods

#### AuthenticationResponse
```go
func (*AuthenticationSASLContinue) AuthenticationResponse()
```
Backend identifies this message as an authentication response.

#### Backend
```go
func (*AuthenticationSASLContinue) Backend()
```
Backend identifies this message as sendable by the PostgreSQL backend.

#### Decode
```go
func (dst *AuthenticationSASLContinue) 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.

#### Encode
```go
func (src *AuthenticationSASLContinue) Encode(dst []byte) ([]byte, error)
```
Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### MarshalJSON
```go
func (src AuthenticationSASLContinue) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.
```

--------------------------------

### ChunkReader Interface and Function

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Provides an interface for reading data in chunks and a function to create a ChunkReader.

```APIDOC
## ChunkReader

### Description
An interface to decouple chunk reading functionality.

### Interface
#### `ChunkReader`
```go
interface {
	Next(n int) (buf []byte, err error)
}
```
- **Next(n int)**: Returns a buffer filled with the next `n` bytes. If an error occurs, `buf` must be `nil`. Preserves partially read data and does not reuse `buf`.

### Function
#### `NewChunkReader`
```go
func NewChunkReader(r io.Reader) ChunkReader
```
Creates and returns a new default `ChunkReader` from an `io.Reader`.
```

--------------------------------

### Define AuthenticationSASLFinal

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents a backend message indicating SASL authentication completion.

```go
type AuthenticationSASLFinal struct {
	Data []byte
}
```

--------------------------------

### AuthenticationMD5Password

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles MD5 password authentication messages.

```APIDOC
## AuthenticationMD5Password

### Description
Handles MD5 password authentication messages. Provides methods for decoding and encoding these messages.

### Methods

#### Decode
```go
func (dst *AuthenticationMD5Password) 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.

#### Encode
```go
func (src *AuthenticationMD5Password) Encode(dst []byte) ([]byte, error)
```
Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### MarshalJSON
```go
func (src AuthenticationMD5Password) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.

#### UnmarshalJSON
```go
func (dst *AuthenticationMD5Password) UnmarshalJSON(data []byte) error
```
UnmarshalJSON implements encoding/json.Unmarshaler.
```

--------------------------------

### EmptyQueryResponse Backend Identification

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies the EmptyQueryResponse message as sendable by the PostgreSQL backend.

```go
func (*EmptyQueryResponse) Backend()

```

--------------------------------

### SASLInitialResponse

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents an initial response for SASL authentication. It includes the authentication mechanism and associated data.

```APIDOC
## SASLInitialResponse

### Description
Represents an initial response for SASL authentication. It includes the authentication mechanism and associated data.

### Type Definition
```go
type SASLInitialResponse struct {
	AuthMechanism string
	Data          []byte
}
```

### Methods
#### Decode
```go
func (dst *SASLInitialResponse) Decode(src []byte) error
```
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.

#### Encode
```go
func (src *SASLInitialResponse) Encode(dst []byte) ([]byte, error)
```
Encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### Frontend
```go
func (*SASLInitialResponse) Frontend()
```
Frontend identifies this message as sendable by a PostgreSQL frontend.

#### MarshalJSON
```go
func (src SASLInitialResponse) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.

#### UnmarshalJSON
```go
func (dst *SASLInitialResponse) UnmarshalJSON(data []byte) error
```
UnmarshalJSON implements encoding/json.Unmarshaler. added in v2.1.0
```

--------------------------------

### Authentication Message Types

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Structures for handling various PostgreSQL authentication message types.

```APIDOC
## Authentication Message Types

### Description
These types represent different authentication states and responses in the PostgreSQL protocol.

### Supported Types
- **AuthenticationCleartextPassword**
- **AuthenticationGSS**
- **AuthenticationGSSContinue**
- **AuthenticationMD5Password**
- **AuthenticationOk**
- **AuthenticationSASL**
- **AuthenticationSASLContinue**
- **AuthenticationSASLFinal**

### Common Methods
- **Decode(src []byte) error** - Decodes raw bytes into the message structure.
- **Encode(dst []byte) ([]byte, error)** - Encodes the message structure into bytes.
- **MarshalJSON() ([]byte, error)** - Serializes the message to JSON.
```

--------------------------------

### Backend Identification for ErrorResponse in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies an ErrorResponse message as sendable by the PostgreSQL backend.

```go
func (*ErrorResponse) Backend()
```

--------------------------------

### DataRow UnmarshalJSON Implementation (v2.1.0+)

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Unmarshaler interface for DataRow. Added in v2.1.0.

```go
func (dst *DataRow) UnmarshalJSON(data []byte) error

```

--------------------------------

### Execute Struct Definition in Go

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the structure for an Execute message, containing portal name and maximum rows to fetch.

```go
type Execute struct {
	Portal  string
	MaxRows uint32
}
```

--------------------------------

### GSSResponse Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the GSSResponse message structure and its associated protocol and JSON methods.

```go
type GSSResponse struct {
	Data []byte
}
```

```go
func (*GSSResponse) Decode(data []byte) error
```

```go
func (*GSSResponse) Encode(g *GSSResponse) ([]byte, error)
```

```go
func (*GSSResponse) Frontend()
```

```go
func (*GSSResponse) MarshalJSON() ([]byte, error)
```

```go
func (*GSSResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### PostgreSQL Authentication Message Constants

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Constants defining different authentication methods supported by PostgreSQL. These are used to identify the type of authentication message.

```go
const (
	AuthTypeOk                = 0
	AuthTypeCleartextPassword = 3
	AuthTypeMD5Password       = 5
	AuthTypeSCMCreds          = 6
	AuthTypeGSS               = 7
	AuthTypeGSSCont           = 8
	AuthTypeSSPI              = 9
	AuthTypeSASL              = 10
	AuthTypeSASLContinue      = 11
	AuthTypeSASLFinal         = 12
)
```

--------------------------------

### BackendMessage Interface

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Interface for messages that can be sent by the PostgreSQL backend.

```APIDOC
## BackendMessage Interface

### Description
BackendMessage is an interface for messages that can be sent by the PostgreSQL backend.

### Methods
- **Message**: Embeds the Message interface.
- **Backend**(): A no-op method to distinguish backend messages from frontend messages.

```

--------------------------------

### CopyOutResponse UnmarshalJSON Implementation (v2.1.0+)

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Unmarshaler interface for CopyOutResponse. Added in v2.1.0.

```go
func (dst *CopyOutResponse) UnmarshalJSON(data []byte) error

```

--------------------------------

### EmptyQueryResponse Decode Method

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Decodes a byte slice into an EmptyQueryResponse. The input must be the complete message excluding the initial message type identifier and length.

```go
func (dst *EmptyQueryResponse) Decode(src []byte) error

```

--------------------------------

### Marshal Terminate to JSON

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Marshaler interface for the Terminate type.

```go
func (src Terminate) MarshalJSON() ([]byte, error)
```

--------------------------------

### Bind Message

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

The Bind message is used to execute a prepared statement with given parameters. It can be encoded and decoded.

```APIDOC
## Bind Message

### Description
Represents a PostgreSQL Bind message, used to execute a prepared statement with parameters.

### Method
N/A (Struct definition and methods)

### Endpoint
N/A

### Parameters
#### Fields
- **DestinationPortal** (string) - Description of the destination portal.
- **PreparedStatement** (string) - Name of the prepared statement to execute.
- **ParameterFormatCodes** ([]int16) - Format codes for the parameters.
- **Parameters** ([][]byte) - The parameters to send with the statement.
- **ResultFormatCodes** ([]int16) - Format codes for the results.

### Methods
#### Decode
```go
func (dst *Bind) Decode(src []byte) error
```
Decodes a Bind message from a byte slice. `src` must contain the complete message excluding the initial message type and length.

#### Encode
```go
func (src *Bind) Encode(dst []byte) ([]byte, error)
```
Encodes the Bind message into a byte slice. `dst` will include the message type and length.

#### Frontend
```go
func (*Bind) Frontend()
```
Identifies this message as sendable by a PostgreSQL frontend.

#### MarshalJSON
```go
func (src Bind) MarshalJSON() ([]byte, error)
```
Implements `encoding/json.Marshaler`.

#### UnmarshalJSON
```go
func (dst *Bind) UnmarshalJSON(data []byte) error
```
Implements `encoding/json.Unmarshaler`.
```

--------------------------------

### CopyInResponse UnmarshalJSON Implementation (v2.1.0+)

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Implements the encoding/json.Unmarshaler interface for CopyInResponse. Added in v2.1.0.

```go
func (dst *CopyInResponse) UnmarshalJSON(data []byte) error

```

--------------------------------

### Identify Terminate as Frontend Message

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Indicates that the Terminate message is intended to be sent by a PostgreSQL frontend.

```go
func (*Terminate) Frontend()
```

--------------------------------

### CommandComplete Message

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles the CommandComplete message structure used to signal the completion of a SQL command.

```APIDOC
## CommandComplete Message

### Description
Represents the CommandComplete message, which identifies the completion of a command. It supports encoding, decoding, and JSON serialization.

### Methods
- **Backend()**: Identifies this message as sendable by the PostgreSQL backend.
- **Decode(src []byte)**: Decodes the message from raw bytes.
- **Encode(dst []byte)**: Encodes the message into raw bytes including type and length headers.
- **MarshalJSON()**: Implements encoding/json.Marshaler.
- **UnmarshalJSON(data []byte)**: Implements encoding/json.Unmarshaler.
```

--------------------------------

### GSSEncRequest Message Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the GSSEncRequest message structure and its associated protocol methods.

```go
type GSSEncRequest struct {
}
```

```go
func (*GSSEncRequest) Decode(src []byte) error
```

```go
func (*GSSEncRequest) Encode(src []byte) ([]byte, error)
```

```go
func (*GSSEncRequest) Frontend()
```

```go
func (GSSEncRequest) MarshalJSON() ([]byte, error)
```

--------------------------------

### BigEndianBuf

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

An 8-byte buffer for big-endian integer encoding.

```APIDOC
## BigEndianBuf

### Description
BigEndianBuf is an 8-byte buffer used for big-endian integer encoding.

### Methods
- **Int16**(n int16) []byte: Encodes an int16 into the buffer.
- **Int32**(n int32) []byte: Encodes an int32 into the buffer.
- **Int64**(n int64) []byte: Encodes an int64 into the buffer.
- **Uint16**(n uint16) []byte: Encodes a uint16 into the buffer.

```

--------------------------------

### AuthenticationSASL

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles SASL authentication messages.

```APIDOC
## AuthenticationSASL

### Description
AuthenticationSASL is a message sent from the backend indicating that SASL authentication is required. It includes the supported authentication mechanisms.

### Methods

#### AuthenticationResponse
```go
func (*AuthenticationSASL) AuthenticationResponse()
```
Backend identifies this message as an authentication response.

#### Backend
```go
func (*AuthenticationSASL) Backend()
```
Backend identifies this message as sendable by the PostgreSQL backend.

#### Decode
```go
func (dst *AuthenticationSASL) 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.

#### Encode
```go
func (src *AuthenticationSASL) Encode(dst []byte) ([]byte, error)
```
Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.

#### MarshalJSON
```go
func (src AuthenticationSASL) MarshalJSON() ([]byte, error)
```
MarshalJSON implements encoding/json.Marshaler.
```

--------------------------------

### DataRow Encode Method

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Encodes a DataRow into a byte slice, including the message type identifier and length.

```go
func (src *DataRow) Encode(dst []byte) ([]byte, error)

```

--------------------------------

### CopyOutResponse Backend Identification

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Identifies the CopyOutResponse message as sendable by the PostgreSQL backend.

```go
func (*CopyOutResponse) Backend()

```

--------------------------------

### RowDescription API

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Handles backend messages describing the rows returned by a query.

```APIDOC
## RowDescription

### Description
Represents a RowDescription message sent by the PostgreSQL backend.

### Methods
- **Decode(src []byte) error**: Decodes binary data into the struct.
- **Encode(dst []byte) ([]byte, error)**: Encodes the struct into binary format.
- **MarshalJSON() ([]byte, error)**: Implements encoding/json.Marshaler.
- **UnmarshalJSON(data []byte) error**: Implements encoding/json.Unmarshaler.
- **Backend()**: Identifies as a backend message.
```

--------------------------------

### Close Message Operations

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Structures and methods for handling PostgreSQL Close messages.

```go
type Close struct {
	ObjectType byte // 'S' = prepared statement, 'P' = portal
	Name       string
}
```

```go
func (dst *Close) Decode(src []byte) error
```

```go
func (src *Close) Encode(dst []byte) ([]byte, error)
```

```go
func (*Close) Frontend()
```

```go
func (src Close) MarshalJSON() ([]byte, error)
```

```go
func (dst *Close) UnmarshalJSON(data []byte) error
```

--------------------------------

### AuthenticationMD5Password Type

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Represents a message requiring an MD5 hashed password. It includes a 4-byte salt. Use Decode and Encode for message handling.

```go
type AuthenticationMD5Password struct {
	Salt [4]byte
}
```

```go
func (*AuthenticationMD5Password) AuthenticationResponse(){
}
```

```go
func (*AuthenticationMD5Password) Backend(){
}
```

--------------------------------

### SASLResponse Structure and Methods

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Defines the SASL response message and its associated encoding, decoding, and JSON marshaling methods.

```go
type SASLResponse struct {
	Data []byte
}
```

```go
func (dst *SASLResponse) Decode(src []byte) error
```

```go
func (src *SASLResponse) Encode(dst []byte) ([]byte, error)
```

```go
func (*SASLResponse) Frontend()
```

```go
func (src SASLResponse) MarshalJSON() ([]byte, error)
```

```go
func (dst *SASLResponse) UnmarshalJSON(data []byte) error
```

--------------------------------

### CloseComplete Message Operations

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Structures and methods for handling PostgreSQL CloseComplete messages.

```go
type CloseComplete struct{}
```

```go
func (*CloseComplete) Backend()
```

```go
func (dst *CloseComplete) Decode(src []byte) error
```

```go
func (src *CloseComplete) Encode(dst []byte) ([]byte, error)
```

--------------------------------

### Uint32 BigEndianBuf

Source: https://pkg.go.dev/github.com/jackc/pgproto3/v2

Converts a uint32 value into a big-endian byte slice.

```go
func (b BigEndianBuf) Uint32(n uint32) []byte
```
Tokens:
Raw