2
0

Add a lot of documentation

This commit is contained in:
Jack Christensen
2019-06-08 19:38:34 -05:00
parent bf3a27ae3f
commit 432c2951c7
41 changed files with 202 additions and 1 deletions
+5
View File
@@ -12,8 +12,11 @@ type Describe struct {
Name string
}
// Frontend identifies this message as sendable by a PostgreSQL frontend.
func (*Describe) Frontend() {}
// 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.
func (dst *Describe) Decode(src []byte) error {
if len(src) < 2 {
return &invalidMessageFormatErr{messageType: "Describe"}
@@ -32,6 +35,7 @@ func (dst *Describe) Decode(src []byte) error {
return nil
}
// Encode encodes src into dst. dst will include the 1 byte message type identifier and the 4 byte message length.
func (src *Describe) Encode(dst []byte) []byte {
dst = append(dst, 'D')
sp := len(dst)
@@ -46,6 +50,7 @@ func (src *Describe) Encode(dst []byte) []byte {
return dst
}
// MarshalJSON implements encoding/json.Marshaler.
func (src *Describe) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string